Struct Ui 

pub struct Ui<'ply, CustomElementData: Clone + Default + Debug = ()> { /* private fields */ }

Implementations

impl<'ply, CustomElementData: Clone + Default + Debug> Ui<'ply, CustomElementData>

pub fn element(&mut self) -> ElementBuilder<'_, CustomElementData>

Creates a new element builder for configuring and adding an element. Finalize with .children(|ui| {...}) or .empty().

pub fn text( &mut self, text: &str, config_fn: impl FnOnce(&mut TextConfig) -> &mut TextConfig, )

Adds a text element to the current open element or to the root layout.

pub fn scroll_offset(&self) -> Vector2

Returns the current scroll offset of the open scroll container.

pub fn hovered(&self) -> bool

Returns if the current element you are creating is hovered

pub fn pressed(&self) -> bool

Returns if the current element you are creating is pressed (pointer held down on it, or Enter/Space held on focused element)

pub fn focused(&self) -> bool

Returns if the current element you are creating has focus.

Methods from Deref<Target = Ply<CustomElementData>>

pub fn begin(&mut self) -> Ui<'_, CustomElementData>

Starts a new frame, returning a Ui handle for building the element tree.

pub fn pointer_over(&self, cfg: impl Into<Id>) -> bool

Returns true if the pointer is currently over the element with the given ID.

pub fn pointer_over_ids(&self) -> Vec<Id>

Z-sorted list of element IDs that the cursor is currently over

pub fn set_measure_text_function<F>(&mut self, callback: F)

where F: Fn(&str, &TextConfig) -> Dimensions + 'static,

Set the callback for text measurement

pub fn max_element_count(&mut self, max_element_count: u32)

Sets the maximum number of elements that ply supports Use only if you know what you are doing or you’re getting errors from ply

pub fn max_measure_text_cache_word_count(&mut self, count: u32)

Sets the capacity of the cache used for text in the measure text function Use only if you know what you are doing or you’re getting errors from ply

pub fn set_debug_mode(&mut self, enable: bool)

Enables or disables the debug mode of ply

pub fn is_debug_mode(&self) -> bool

Returns if debug mode is enabled

pub fn set_culling(&mut self, enable: bool)

Enables or disables culling

pub fn set_layout_dimensions(&mut self, dimensions: Dimensions)

Sets the dimensions of the global layout. Use if, for example the window size you render changed.

pub fn pointer_state(&mut self, position: Vector2, is_down: bool)

Updates the state of the pointer for ply. Used to update scroll containers and for interactions functions.

pub fn update_scroll_containers( &mut self, drag_scrolling_enabled: bool, scroll_delta: Vector2, delta_time: f32, )

Processes scroll containers using the current pointer state and scroll delta.

pub fn focused_element(&self) -> Option<Id>

Returns the ID of the currently focused element, or None.

pub fn set_focus(&mut self, id: impl Into<Id>)

Sets focus to the element with the given ID.

pub fn clear_focus(&mut self)

Clears focus (no element is focused).

pub fn get_text_value(&self, id: impl Into<Id>) -> &str

Returns the text value of a text input element. Returns an empty string if the element is not a text input or doesn’t exist.

pub fn set_text_value(&mut self, id: impl Into<Id>, value: &str)

Sets the text value of a text input element.

pub fn get_cursor_pos(&self, id: impl Into<Id>) -> usize

Returns the cursor position of a text input element. Returns 0 if the element is not a text input or doesn’t exist.

pub fn set_cursor_pos(&mut self, id: impl Into<Id>, pos: usize)

Sets the cursor position of a text input element. Clamps to the text length and clears any selection.

pub fn get_selection_range(&self, id: impl Into<Id>) -> Option<(usize, usize)>

Returns the selection range (start, end) for a text input element, or None.

pub fn set_selection(&mut self, id: impl Into<Id>, anchor: usize, cursor: usize)

Sets the selection range for a text input element. anchor is where selection started, cursor is where it ends.

pub fn is_pressed(&self, id: impl Into<Id>) -> bool

Returns true if the given element is currently pressed.

pub fn bounding_box(&self, id: impl Into<Id>) -> Option<BoundingBox>

Returns the bounding box of the element with the given ID, if it exists.

pub fn scroll_container_data( &self, id: impl Into<Id>, ) -> Option<ScrollContainerData>

Returns scroll container state for the element with the given ID, if it is a scroll container.

pub fn eval(&mut self) -> Vec<RenderCommand<CustomElementData>>

Evaluate the layout and return all render commands.

pub async fn show( &mut self, handle_custom_command: impl Fn(&RenderCommand<CustomElementData>), )

Evaluate the layout and render all commands.

Trait Implementations

impl<'ply, CustomElementData: Clone + Default + Debug> Deref for Ui<'ply, CustomElementData>

type Target = Ply<CustomElementData>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'ply, CustomElementData: Clone + Default + Debug> DerefMut for Ui<'ply, CustomElementData>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.