Struct Kit 

pub struct Kit<A: UiAction> { /* private fields */ }

The scale, tokens, sink and nav map a panel’s controls are built from.

Build one per game and clone it into whatever composes: the scale cell, the sink and the nav map are shared behind Rc/Arc, so every clone sees the same frame. A kit rebuilt every frame would start from an empty nav map, whose one-frame rectangle binding would never complete and whose controls could never be reached.

Implementations

impl<A: UiAction> Kit<A>

pub fn new(scale: Scale, tokens: Tokens, sink: Sink<A>) -> Self

A kit drawing with tokens, pushing into sink and registering in a fresh nav map.

pub fn with_map( scale: Scale, tokens: Tokens, sink: Sink<A>, nav: NavMap, ) -> Self

A kit wrapping an existing nav map, so a game that keeps its own map still shares it with the controls.

pub fn set_scale(&self, scale: Scale)

This frame’s viewport scale. All clones of the kit see it.

pub fn scale(&self) -> Scale

pub fn tokens(&self) -> Tokens

pub fn with_tokens(self, tokens: Tokens) -> Self

Replace the palette. Returns the re-skinned kit.

pub fn with_wrap(self, wrap: Wrap) -> Self

Edge behaviour for directional traversal.

pub fn sink(&self) -> &Sink<A>

pub fn nav_map(&self) -> &NavMap

pub fn driver(&self) -> NavDriver

Traversal over this kit’s controls.

pub fn begin_frame(&self)

Retire the controls that are no longer composed: call once per frame, before composing panels.

pub fn button(&self, text: impl Into<String>, action: A) -> Button<A>

A chunky text button that pushes action and takes focus.

pub fn icon_button(&self, glyph: impl Into<String>, action: A) -> Button<A>

A square glyph button (play, pause, home) that pushes action.

pub fn chip(&self, text: impl Into<String>, face: Color) -> View

An information chip: a HUD counter, score or timer face.

pub fn panel( &self, viewport: [f32; 2], anchor: [f32; 4], offset: [f32; 4], face: Color, ) -> View

A card: the panel body, placed by viewport anchor and design-unit offset, stacking its children in a column with the default gap.

Add children to the returned view; they are centred as a column, which is what every template menu is.

pub fn scrim(&self) -> View

The dim behind a modal panel: full-bleed, and it blocks pointer input so a click cannot reach the game underneath. It stays out of the focus chain.

pub fn label( &self, modifier: Modifier, text: &str, size: f32, fill: Color, ) -> View

Outlined text: labels that must read over game art.

pub fn label_plain( &self, modifier: Modifier, text: &str, size: f32, fill: Color, ) -> View

Plain text: numbers and button captions, no outline.

pub fn display( &self, modifier: Modifier, text: &str, size: f32, fill: Color, ) -> View

Display text: tighter tracking and a heavier faux-bold, for titles.

pub fn icon(&self, glyph: &str, size: f32, fill: Color) -> View

A Material Symbols glyph.

pub fn disc( &self, viewport: [f32; 2], at: [f32; 2], radius: f32, color: Color, ) -> View

A filled circle in design space.

pub fn ring( &self, viewport: [f32; 2], at: [f32; 2], radius: f32, width: f32, color: Color, ) -> View

An unfilled circle in design space.

pub fn place( &self, viewport: [f32; 2], anchor: [f32; 4], offset: [f32; 4], ) -> Modifier

The rect(vp, s, anchor, offset) placement helper, with this kit’s scale.

pub fn touch_pad(&self) -> TouchPad<A>

The virtual stick and tap buttons, pushing into the same sink.

Build the pad once and keep it in the app, like the game’s own input state: a pad built per frame forgets the finger that is down.

Trait Implementations

impl<A: Clone + UiAction> Clone for Kit<A>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.