Enum OverlayShape 

pub enum OverlayShape {
    Rect {
        corner_radius: f32,
    },
    RoundedRect {
        radii: [f32; 4],
    },
    Circle,
    Ellipse,
    Capsule,
    Ring {
        inner_radius_frac: f32,
    },
    Arc {
        inner_radius_frac: f32,
        start_angle: f32,
        end_angle: f32,
    },
    Triangle {
        direction: TriangleDirection,
    },
    Line {
        thickness: f32,
        cap: LineCap,
    },
    Star {
        points: u32,
        inner_radius_frac: f32,
    },
    RegularPolygon {
        sides: u32,
    },
    Cross {
        arm_width_frac: f32,
    },
}

Shape type for an OverlayShapeItem.

Each variant maps to a signed-distance function evaluated per fragment on the GPU. The bounding quad is defined by OverlayShapeItem::position and size; the shape variant controls which SDF is used and how the extra radii parameters are interpreted.

Variants

Rect

Axis-aligned rectangle with a uniform corner radius.

Fields

corner_radius: f32

Corner radius in logical pixels. 0.0 produces sharp corners.

RoundedRect

Axis-aligned rectangle with independent corner radii. Order: top-left, top-right, bottom-right, bottom-left.

Fields

radii: [f32; 4]

Per-corner radii in logical pixels.

Circle

Circle inscribed in the bounding box (the smaller dimension wins).

Ellipse

Ellipse filling the bounding box.

Capsule

Pill / capsule shape: fully rounded along the shorter axis.

Ring

Hollow circle (annulus). The ring wall occupies the space between the outer edge (defined by size) and the inner hole.

Fields

inner_radius_frac: f32

Inner radius as a fraction of the inscribed radius. 0.0 produces a solid circle; 0.9 produces a thin ring. Clamped to 0.0..1.0.

Arc

Arc (pie-slice or annular sector). Combines a ring with an angular range so you can draw progress indicators, radial menus, and pie charts.

Fields

inner_radius_frac: f32

Inner radius as a fraction of the inscribed radius. 0.0 gives a solid pie slice; values near 1.0 give a thin arc stroke.

start_angle: f32

Start angle in radians. 0.0 points right, angles increase counter-clockwise.

end_angle: f32

End angle in radians. The filled region sweeps CCW from start_angle to end_angle.

Triangle

Triangle oriented in one of four cardinal directions, fitted to the bounding box.

Fields

direction: TriangleDirection

Which direction the triangle points.

Line

Line segment from the top-left to the bottom-right corner of the bounding box with a fixed stroke width. For axis-aligned strokes, set the minor dimension of size to a small value (e.g. 0.1).

Fields

thickness: f32

Stroke width in logical pixels.

cap: LineCap

End-cap style: Round (default) or Square.

Star

N-pointed star inscribed in the bounding box.

Fields

points: u32

Number of points. Typical values: 4, 5, 6.

inner_radius_frac: f32

Inner radius as a fraction of the outer radius. Lower values produce sharper, more pointed tips. Typical value: 0.5.

RegularPolygon

Regular convex polygon with N sides, inscribed in the bounding box.

Fields

sides: u32

Number of sides. 3 = triangle, 4 = square (45-deg rotated), 6 = hexagon, etc.

Cross

Plus/cross shape: the union of a horizontal and a vertical rectangle.

Fields

arm_width_frac: f32

Arm width as a fraction of the smaller half-dimension of the bounding box. 1.0 fills the entire bounding box; 0.3 gives thin arms. Clamped to 0.0..1.0.

Trait Implementations

impl Clone for OverlayShape

fn clone(&self) -> OverlayShape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OverlayShape

impl Debug for OverlayShape

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

Formats the value using the given formatter.

impl Default for OverlayShape

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for OverlayShape

fn eq(&self, other: &OverlayShape) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OverlayShape