yog_ui/
lib.rs

1//! yog-ui — retained-mode UI framework for Yog mods.
2//!
3//! Flexbox-inspired layout engine + GPU rendering via [`yog-gfx`].
4//! Use for custom inventories, guide books, tooltips, HUD overlays.
5//!
6//! # Quick start
7//! ```ignore
8//! use yog_ui::{UiRoot, widget, Align, FlexDir, Units};
9//!
10//! let ui = UiRoot::new("mymod:main_menu")
11//!     .style(|s| s.bg(0x88332211).padding(8.0, 8.0, 8.0, 8.0))
12//!     .child(
13//!         widget::panel(FlexDir::Column).gap(4.0)
14//!             .child(widget::label("Hello, World!").color(0xFF_DDAA00))
15//!             .child(widget::button("Click me").on_click("mymod:btn_click"))
16//!     );
17//! ```
18
19pub mod layout;
20mod render;
21pub mod scroll;
22pub mod text;
23pub mod widget;
24
25pub use layout::{set_focus, Align, FlexDir, LayoutNode, Rect};
26pub use scroll::ScrollState;
27pub use widget::{Dock, FocusStyle, Units, Widget};
28
29use yog_gfx::GfxContext;
30
31/// Top-level UI tree.  Build it, call [`layout`], then [`render`] each frame.
32pub struct UiRoot {
33    pub id: String,
34    pub root: Widget,
35    pub layout_root: LayoutNode,
36    pub needs_layout: bool,
37}
38
39impl UiRoot {
40    pub fn new(id: impl Into<String>, root: Widget) -> Self {
41        Self {
42            id: id.into(),
43            root,
44            layout_root: LayoutNode::default(),
45            needs_layout: true,
46        }
47    }
48
49    /// Recalculate layout. Call after changing the tree or on window resize.
50    pub fn layout(&mut self, screen_w: f32, screen_h: f32) {
51        self.layout_root = layout::compute(&self.root, screen_w, screen_h);
52        self.needs_layout = false;
53    }
54
55    /// Render the UI tree via `yog-gfx` draw2d.
56    /// Must be called from `on_hud_render`.
57    pub fn render(&self, ctx: &GfxContext) {
58        let d2d = ctx.draw2d();
59        render::render_node(&d2d, &self.root, &self.layout_root);
60    }
61
62    /// Find the deepest clickable widget at `(mx, my)` in screen coordinates.
63    pub fn hit_test(&self, mx: f32, my: f32) -> Option<&LayoutNode> {
64        layout::hit_test(&self.layout_root, mx, my)
65    }
66
67    /// Resolved rect of the (first) node tagged `id` — see [`layout::find_by_id`].
68    /// Call after [`Self::layout`].
69    pub fn find_rect(&self, id: &str) -> Option<Rect> {
70        layout::find_by_id(&self.layout_root, id)
71    }
72
73    /// Laid-out node of the (first) widget tagged `id` — rect plus scroll
74    /// state, see [`layout::find_node`]. Call after [`Self::layout`].
75    pub fn find_node(&self, id: &str) -> Option<&LayoutNode> {
76        layout::find_node(&self.layout_root, id)
77    }
78}
yog_ui/lib.rs

yog_ui/
lib.rs
