Struct AnnotationLabel 

#[non_exhaustive]
pub struct AnnotationLabel {
    pub world_pos: Vec3,
    pub text: String,
    pub leader_end: Option<Vec3>,
    pub color: [f32; 4],
    pub font_size: f32,
    pub background: bool,
}

A text label pinned to a 3D world position.

Labels are rendered by the caller (typically via egui’s painter) after projecting the world position to screen space using world_to_screen or world_to_screen_from_frame. No wgpu pipeline changes are required.

Examples

let mut label = AnnotationLabel::default();
label.world_pos = glam::Vec3::new(0.0, 5.0, 0.0);
label.text = "Inlet".to_string();
label.color = [0.4, 0.8, 1.0, 1.0]; // light blue

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

world_pos: Vec3

3D world-space position the label is pinned to.

text: String

Text content to display.

leader_end: Option<Vec3>

Optional world-space endpoint for an offset callout leader line.

When Some(end), callers should project end to screen space and draw a line segment from the leader end to the label’s screen position.

color: [f32; 4]

RGBA colour in linear float format. Default: opaque white [1.0, 1.0, 1.0, 1.0].

font_size: f32

Font size in egui points. Default: 14.0.

background: bool

Whether to draw a semi-transparent background rectangle behind the text. Default: true.

Trait Implementations

impl Clone for AnnotationLabel

fn clone(&self) -> AnnotationLabel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotationLabel

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

Formats the value using the given formatter.

impl Default for AnnotationLabel

fn default() -> Self

Returns the “default value” for a type.