Struct let_engine::objects::labels::Label

pub struct Label<Object> {
    pub object: Object,
    pub font: Font,
    pub text: String,
    pub scale: Vec2,
    pub align: Direction,
    /* 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

object: Object

font: Font

text: String

scale: Vec2

align: Direction

Implementations

impl Label<NewObject>

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

Creates a new label with the given settings.

pub fn init(self, layer: &Arc<Layer>) -> Result<Label<Object>>

pub fn init_with_parent( self, layer: &Arc<Layer>, parent: &Object ) -> Result<Label<Object>>

pub fn init_with_optional_parent( self, layer: &Arc<Layer>, parent: Option<&Object> ) -> Result<Label<Object>>

impl Label<Object>

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: impl Into<String>)

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

pub fn sync(&mut self)

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

Trait Implementations

impl<Object: Clone> Clone for Label<Object>

fn clone(&self) -> Label<Object>

Returns a copy of the value.

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

Performs copy-assignment from source.