Struct let_engine::prelude::labels::Label

pub struct Label {
    pub transform: Transform,
    pub appearance: Appearance,
    pub font: Font,
    pub text: String,
    pub scale: Vec2,
    pub align: [f32; 2],
    /* private fields */
}

A Label object made to display text.

note

It is recommended to sync or update the text with all other visible labels so the texture of all labels change to the same texture. At the beginning of the game update all the text gets rendered if any labels changed. This produces a new texture which if not synced to every label produces multiple textures, which take more memory.

Fields

transform: Transform

appearance: Appearance

font: Font

text: String

scale: Vec2

align: [f32; 2]

Implementations

impl Label

pub fn new( resources: &Resources, font: &Font, create_info: LabelCreateInfo ) -> Self

Creates a new label with the given settings.

pub fn update(&mut self)

Updates the local information of this label from the layer, in case it has changed if for example the parent was changed too.

pub fn update_text(&mut self, text: String)

Changes the text of the label and updates it on the layer.

pub fn sync(&self)

Syncs the public layer side label to be the same as the current.

Trait Implementations

impl Clone for Label

fn clone(&self) -> Label

Returns a copy of the value.

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

Performs copy-assignment from source.

impl GameObject for Label

fn transform(&self) -> Transform

Returns the transform of the label.

fn set_isometry(&mut self, position: Vec2, rotation: f32)

Sets the position and rotation of the label.

fn public_transform(&self) -> Transform

Returns the public position of the label.

fn appearance(&self) -> &Appearance

Returns a reference of the appearance of the label.

fn id(&self) -> usize

Returns the index of the label in the layer it’s inside.

fn set_parent_transform(&mut self, transform: Transform)

fn init_to_layer( &mut self, id: usize, parent: &NObject, rigid_body_parent: RigidBodyParent, _layer: &Layer ) -> NObject

fn remove_event(&mut self)

fn as_any(&self) -> &dyn Any

fn as_node(&self) -> NObject

fn collider_handle(&self) -> Option<ColliderHandle>

fn rigidbody_handle(&self) -> Option<RigidBodyHandle>