Struct bevy::ui::node_bundles::TextBundle

pub struct TextBundle {
    pub node: Node,
    pub style: Style,
    pub text: Text,
    pub calculated_size: CalculatedSize,
    pub focus_policy: FocusPolicy,
    pub transform: Transform,
    pub global_transform: GlobalTransform,
    pub visibility: Visibility,
    pub computed_visibility: ComputedVisibility,
    pub z_index: ZIndex,
}

A UI node that is text

Fields

node: Node

Describes the size of the node

style: Style

Describes the style including flexbox settings

text: Text

Contains the text of the node

calculated_size: CalculatedSize

The calculated size based on the given image

focus_policy: FocusPolicy

Whether this node should block interaction with lower nodes

transform: Transform

The transform of the node

This field is automatically managed by the UI layout system. To alter the position of the NodeBundle, use the properties of the Style component.

global_transform: GlobalTransform

The global transform of the node

This field is automatically managed by the UI layout system. To alter the position of the NodeBundle, use the properties of the Style component.

visibility: Visibility

Describes the visibility properties of the node

computed_visibility: ComputedVisibility

Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering

z_index: ZIndex

Indicates the depth at which the node should appear in the UI

Implementations

impl TextBundle

pub fn from_section(value: impl Into<String>, style: TextStyle) -> TextBundle

Create a TextBundle from a single section.

See Text::from_section for usage.

pub fn from_sections(
    sections: impl IntoIterator<Item = TextSection>
) -> TextBundle

Create a TextBundle from a list of sections.

See Text::from_sections for usage.

pub const fn with_text_alignment(self, alignment: TextAlignment) -> TextBundle

Returns this TextBundle with a new TextAlignment on Text.

pub const fn with_style(self, style: Style) -> TextBundle

Returns this TextBundle with a new Style.

Trait Implementations

impl Clone for TextBundle

fn clone(&self) -> TextBundle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextBundle

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

Formats the value using the given formatter.

impl Default for TextBundle

fn default() -> TextBundle

Returns the “default value” for a type.

impl Bundle for TextBundle

SAFETY: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order