Struct LabelItem 

pub struct LabelItem {

    pub world_anchor: Option<[f32; 3]>,
    pub screen_anchor: Option<[f32; 2]>,
    pub text: String,
    pub colour: [f32; 4],
    pub font_size: f32,
    pub font: Option<FontHandle>,
    pub background: bool,
    pub background_colour: [f32; 4],
    pub padding: f32,
    pub leader_line: bool,
    pub leader_colour: [f32; 4],
    pub anchor_align: LabelAnchor,
    pub offset: [f32; 2],
    pub opacity: f32,
    pub max_width: Option<f32>,
    pub border_radius: f32,
    pub z_order: i32,
    pub occlude: bool,
}

A text label rendered as a screen-space overlay.

Anchored to a world-space or screen-space position with optional leader line and background box.

Anchoring

Set world_anchor to pin the label to a 3D position that is reprojected each frame. Set screen_anchor for a fixed screen position in logical pixels from the top-left corner. When both are set, screen_anchor takes precedence. World-anchored labels are frustum-culled: they are not drawn when the anchor is behind the camera or outside the viewport.

Examples

let label = LabelItem {
    world_anchor: Some([2.0, 3.0, 0.0]),
    text: "Peak Pressure: 101.3 kPa".into(),
    leader_line: true,
    ..Default::default()
};

Fields

world_anchor: Option<[f32; 3]>

World-space anchor. Projected to screen by the renderer each frame. Set screen_anchor instead for fixed screen positions.

screen_anchor: Option<[f32; 2]>

Screen-space anchor in logical pixels from top-left. Takes precedence over world_anchor when both are set.

text: String

Text content to display.

colour: [f32; 4]

RGBA text colour in linear float format.

font_size: f32

Font size in logical pixels.

font: Option<FontHandle>

Font to use. None uses the built-in default font.

background: bool

Draw a filled rectangle behind the text.

background_colour: [f32; 4]

RGBA colour of the background rectangle.

padding: f32

Padding between the text and the background rectangle edge in logical pixels. Only used when background is true. Default: 3.0.

leader_line: bool

Draw a line from the projected world_anchor to the label text origin. Only drawn when world_anchor is set.

leader_colour: [f32; 4]

RGBA colour of the leader line.

anchor_align: LabelAnchor

Horizontal alignment of the label text relative to its anchor.

offset: [f32; 2]

Pixel offset applied after anchor resolution and alignment. Useful for nudging a label away from its anchor without moving the leader line endpoint. Default: [0.0, 0.0].

opacity: f32

Overall opacity multiplier applied to text, background, and leader line colours. Range 0.0 (invisible) to 1.0 (fully opaque).

max_width: Option<f32>

Maximum text width in logical pixels. When set, text that exceeds this width is wrapped to multiple lines. None disables wrapping.

border_radius: f32

Corner radius of the background rectangle in logical pixels. Only used when background is true. Default: 0.0 (sharp corners).

z_order: i32

Explicit draw order. Labels with lower values are drawn first (further back). Labels with equal z_order are drawn in list order.

occlude: bool

Reserved for depth-based occlusion. Not implemented yet: when true the label is still rendered; behaviour will be defined in a follow-up.

Trait Implementations

impl Clone for LabelItem

fn clone(&self) -> LabelItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LabelItem

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

Formats the value using the given formatter.

impl Default for LabelItem

fn default() -> Self

Returns the “default value” for a type.