Struct bevy::prelude::Text2dBundle

pub struct Text2dBundle {
    pub text: Text,
    pub text_anchor: Anchor,
    pub text_2d_bounds: Text2dBounds,
    pub transform: Transform,
    pub global_transform: GlobalTransform,
    pub visibility: Visibility,
    pub inherited_visibility: InheritedVisibility,
    pub view_visibility: ViewVisibility,
    pub text_layout_info: TextLayoutInfo,
    pub sprite_source: SpriteSource,
}

The bundle of components needed to draw text in a 2D scene via a 2D Camera2dBundle. Example usage.

Fields

text: Text

Contains the text.

With Text2dBundle the alignment field of Text only affects the internal alignment of a block of text and not its relative position which is controlled by the Anchor component. This means that for a block of text consisting of only one line that doesn’t wrap, the alignment field will have no effect.

text_anchor: Anchor

How the text is positioned relative to its transform.

text_anchor does not affect the internal alignment of the block of text, only its position.

text_2d_bounds: Text2dBounds

The maximum width and height of the text.

transform: Transform

The transform of the text.

global_transform: GlobalTransform

The global transform of the text.

visibility: Visibility

The visibility properties of the text.

inherited_visibility: InheritedVisibility

Inherited visibility of an entity.

view_visibility: ViewVisibility

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

text_layout_info: TextLayoutInfo

Contains the size of the text and its glyph’s position and scale data. Generated via TextPipeline::queue_text

sprite_source: SpriteSource

Marks that this is a SpriteSource.

This is needed for visibility computation to work properly.

Trait Implementations

impl Bundle for Text2dBundle

fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>) )

Gets this Bundle’s component ids. This will be None if the component has not been registered.

impl Clone for Text2dBundle

fn clone(&self) -> Text2dBundle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text2dBundle

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

Formats the value using the given formatter.

impl Default for Text2dBundle

fn default() -> Text2dBundle

Returns the “default value” for a type.

impl DynamicBundle for Text2dBundle