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 icon;
29mod image;
30pub mod node_api;
31mod passes;
32mod place;
33pub mod post;
34mod shader;
35mod sim;
36mod svg;
37mod text;
38mod theme;
39mod trim;
40pub mod video;
41pub use video::{VideoInfo, VideoSource, set_video_opener};
42
43pub use builder::{
44    BaseProps, CameraBuilder, CircleBuilder, CodeBuilder, CustomBuilder, EffectBuilder,
45    GridBuilder, GroupBuilder, ImgBuilder, LayoutBuilder, LineBuilder, NodeBuilder,
46    ParticlesBuilder, PathBuilder, PolygonBuilder, RectBuilder, ShaderBuilder, StarBuilder,
47    TxtBuilder, VideoBuilder,
48};
49pub use builder::{lens_drops, ripple, waves};
50pub use draw::{
51    DrawCtx, DrawItem, DrawRng, Layer, LineCap, LineJoin, Paint, Pen, Primitive, Shadow,
52    StrokeStyle,
53};
54pub use graph::{
55    Direction, InspectNode, Justify, LayoutAlign, NodeData, NodeId, NodeKind, SceneGraph, add_site,
56};
57pub use handles::{
58    Camera, Circle, Code, CodeText, CodeTween, Custom, Effect, Grid, Group, Img, Layout, Line,
59    Node, Particles, Path, Polygon, Rect, SLIDE_DISTANCE, Shader, Star, Svg, Txt, Video, View,
60};
61pub use icon::{Icon, IconBuilder, IconStyle};
62pub use image::{ImageSource, RasterImage, VectorImage, VectorShape};
63pub use node_api::Draw;
64pub use passes::{Pass, PassKind, layer_fingerprint, pass_graph};
65pub use place::{Edge, Percent, Place, SafeArea, Side, Span, pct};
66pub use post::{Input, Shade, ShadeOp, apply as apply_shade};
67pub use shader::{ShaderDiag, draft_shaders, set_shader_budget_ms};
68pub use trim::trim;
69
70pub use oxframe_core::{BlendMode, Color, Gradient, GradientKind, Signal};
71pub use oxframe_text::{Align as TextAlign, Lang, MONO, SANS};
72pub use text::{CodeTheme, RichSpan, span};
73/// Theme of the scene that is running, or the dark theme outside one.
74pub use theme::current as current_theme;
75pub use theme::enter as enter_theme;
76pub use theme::{
77    Corner, Ink,
78    Ink::{Accent, Background, Danger, Muted, OnAccent, Success, Surface, Text, Warning},
79    IntoPaint, Len, Motion, Pace,
80    Pace::{Fast, Normal, Slow},
81    Scale, ShadowSpec, Step,
82    Step::{Lg, Md, Sm, Xl, Xs},
83    Theme, TypeRole, TypeScale, TypeStyle,
84};
oxframe_2d/lib.rs

oxframe_2d/
lib.rs
