Struct OverlayPolylineItem 

pub struct OverlayPolylineItem {
    pub points: Vec<[f32; 2]>,
    pub thickness: f32,
    pub colour: [f32; 4],
    pub join: LineJoin,
    pub mitre_limit: f32,
    pub closed: bool,
    pub opacity: f32,
    pub z_order: i32,
}

A stroked polyline rendered as a screen-space overlay.

Constructed from a list of waypoints in logical pixels. Tessellated on the CPU into a triangle list each frame; rendered through the same pipeline as overlay rects and labels (no SDF, no shader changes).

Use OverlayPolylineItem::from_path to construct from a closure that samples a curve at N points (Bezier traces, lissajous, custom paths).

Fields

points: Vec<[f32; 2]>

Waypoints in logical pixels from the viewport top-left.

thickness: f32

Stroke thickness in logical pixels.

colour: [f32; 4]

RGBA colour in linear float format.

join: LineJoin

How segment joints are drawn.

mitre_limit: f32

Mitre limit: when the mitre extension exceeds this multiple of thickness, the joint auto-falls back to a bevel.

closed: bool

When true, the last point connects back to the first.

opacity: f32

Overall opacity multiplier in [0, 1].

z_order: i32

Draw order relative to other overlay rects, polylines, and labels. Lower values render first (further back).

Implementations

impl OverlayPolylineItem

pub fn from_path( path: impl Fn(f32) -> [f32; 2], samples: u32, thickness: f32, colour: [f32; 4], ) -> Self

Construct a polyline by sampling the given closure at samples + 1 evenly-spaced parameter values across [0, 1]. The closure is called once per sample at construction time; the resulting points are stored in self.points.

Consumers wanting non-uniform sample density (denser around tight curvature) should sample manually and build the item via the regular struct literal.

Trait Implementations

impl Clone for OverlayPolylineItem

fn clone(&self) -> OverlayPolylineItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayPolylineItem

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

Formats the value using the given formatter.

impl Default for OverlayPolylineItem

fn default() -> Self

Returns the “default value” for a type.