oxframe_2d/
lib.rs

1//! 2D scene graph of oxframe.
2//!
3//! > **Status:** oxframe is under very active development. The API is not stable yet and
4//! > may change from version to version. Pin the exact version in your Cargo.toml and check
5//! > the [changelog](https://github.com/oxygenframe/oxframe-sdk/blob/main/CHANGELOG.md)
6//! > before upgrading.
7//!
8//! Scene code creates nodes with builders (`Rect::new().width(100.0)`) and
9//! adds them with [`Node::add`] (`view.add(..)`), which returns a `Copy`
10//! handle whose zero-argument methods of the same names return
11//! [`Signal`]s:
12//!
13//! ```ignore
14//! let r = view.add(Rect::new().size(200.0).x(-300.0));
15//! r.x().to(300.0, 1.0).await;
16//! ```
17//!
18//! Renderers consume a flat [`DrawItem`] list produced by
19//! [`SceneGraph::draw_list`], so every backend draws exactly the same thing.
20
21#![warn(missing_docs)]
22
23mod builder;
24mod draw;
25mod flex;
26mod graph;
27mod handles;
28mod image;
29mod passes;
30mod place;
31pub mod post;
32mod shader;
33mod sim;
34mod svg;
35mod text;
36mod theme;
37mod trim;
38
39pub use builder::{
40    BaseProps, CameraBuilder, CircleBuilder, CodeBuilder, CustomBuilder, EffectBuilder,
41    GridBuilder, GroupBuilder, ImgBuilder, LayoutBuilder, LineBuilder, NodeBuilder,
42    ParticlesBuilder, PathBuilder, PolygonBuilder, RectBuilder, ShaderBuilder, StarBuilder,
43    TxtBuilder,
44};
45pub use builder::{lens_drops, ripple, waves};
46pub use draw::{
47    DrawCtx, DrawItem, DrawRng, Layer, LineCap, LineJoin, Paint, Pen, Primitive, Shadow,
48    StrokeStyle,
49};
50pub use graph::{
51    Direction, InspectNode, Justify, LayoutAlign, NodeData, NodeId, NodeKind, SceneGraph, add_site,
52};
53pub use handles::{
54    Camera, Circle, Code, CodeText, CodeTween, Custom, Effect, Grid, Group, Img, Layout, Line,
55    Node, Particles, Path, Polygon, Rect, SLIDE_DISTANCE, Shader, Star, Svg, Txt, View,
56};
57pub use image::{ImageSource, RasterImage, VectorImage, VectorShape};
58pub use passes::{Pass, PassKind, layer_fingerprint, pass_graph};
59pub use place::{Edge, Percent, Place, SafeArea, Side, Span, pct};
60pub use post::{Input, Shade, ShadeOp, apply as apply_shade};
61pub use shader::{ShaderDiag, draft_shaders, set_shader_budget_ms};
62pub use trim::trim;
63
64pub use oxframe_core::{BlendMode, Color, Gradient, GradientKind, Signal};
65pub use oxframe_text::{Align as TextAlign, Lang, MONO, SANS};
66pub use text::{CodeTheme, RichSpan, span};
67/// Theme of the scene that is running, or the dark theme outside one.
68pub use theme::current as current_theme;
69pub use theme::enter as enter_theme;
70pub use theme::{
71    Corner, Ink,
72    Ink::{Accent, Background, Danger, Muted, OnAccent, Success, Surface, Text, Warning},
73    IntoPaint, Len, Motion, Pace,
74    Pace::{Fast, Normal, Slow},
75    Scale, ShadowSpec, Step,
76    Step::{Lg, Md, Sm, Xl, Xs},
77    Theme, TypeRole, TypeScale, TypeStyle,
78};
oxframe_2d/lib.rs

oxframe_2d/
lib.rs
