Struct bevy_ui::UiSurface

pub struct UiSurface { /* private fields */ }

Implementations

impl UiSurface

pub fn upsert_node( &mut self, entity: Entity, style: &Style, context: &LayoutContext )

Retrieves the Taffy node associated with the given UI node entity and updates its style. If no associated Taffy node exists a new Taffy node is inserted into the Taffy layout.

pub fn try_update_measure( &mut self, entity: Entity, measure_func: MeasureFunc ) -> Option<()>

Update the MeasureFunc of the taffy node corresponding to the given Entity if the node exists.

pub fn update_children(&mut self, entity: Entity, children: &Children)

Update the children of the taffy node corresponding to the given Entity.

pub fn try_remove_children(&mut self, entity: Entity)

Removes children from the entity’s taffy node if it exists. Does nothing otherwise.

pub fn try_remove_measure(&mut self, entity: Entity)

Removes the measure from the entity’s taffy node if it exists. Does nothing otherwise.

pub fn set_camera_children( &mut self, camera_id: Entity, children: impl Iterator<Item = Entity> )

Set the ui node entities without a Parent as children to the root node in the taffy layout.

pub fn compute_camera_layout( &mut self, camera: Entity, render_target_resolution: UVec2 )

Compute the layout for each window entity’s corresponding root node in the layout.

pub fn remove_entities(&mut self, entities: impl IntoIterator<Item = Entity>)

Removes each entity from the internal map and then removes their associated node from taffy

pub fn get_layout(&self, entity: Entity) -> Result<&Layout, LayoutError>

Get the layout geometry for the taffy node corresponding to the ui node Entity. Does not compute the layout geometry, compute_window_layouts should be run before using this function.

Trait Implementations

impl Debug for UiSurface

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UiSurface

fn default() -> Self

Returns the “default value” for a type.

impl Resource for UiSurface

where Self: Send + Sync + 'static,