Skip to main content

VectorShape

Enum VectorShape 

Source
#[non_exhaustive]
pub enum VectorShape { Rect { rect: Rect, }, RoundedRect { rect: Rect, radius: f32, }, Circle { center: Vec2, radius: f32, }, Ellipse { center: Vec2, half_extents: Vec2, }, Path { points: Vec<Vec2>, }, }
Expand description

Geometric shape — no paint, no transform. The “what” of a vector primitive.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Rect

Sharp-corner rectangle in NDC.

Fields

§rect: Rect

Axis-aligned bounding rect.

§

RoundedRect

Rounded rectangle in NDC.

Fields

§rect: Rect

Axis-aligned bounding rect.

§radius: f32

Corner radius in NDC units.

§

Circle

Circle in NDC.

Fields

§center: Vec2

Center, NDC.

§radius: f32

Radius, NDC.

§

Ellipse

Anisotropic ellipse in NDC.

Fields

§center: Vec2

Center, NDC.

§half_extents: Vec2

Half-extents (a, b) of the implicit equation (x/a)² + (y/b)² = 1.

§

Path

Closed polygon in NDC. Up to 32 vertices honored by the mask path (matching path_clip.wgsl’s uniform cap).

Fields

§points: Vec<Vec2>

Vertex list. Vec (not slice) so the variant is owned; pay the allocation once per shape construction.

Implementations§

Source§

impl VectorShape

Source

pub fn rect(rect: Rect) -> Self

Convenience constructor.

Source

pub fn rounded_rect(rect: Rect, radius: f32) -> Self

Convenience constructor.

Source

pub fn circle(center: Vec2, radius: f32) -> Self

Convenience constructor.

Source

pub fn ellipse(center: Vec2, half_extents: Vec2) -> Self

Convenience constructor.

Source

pub fn path(points: Vec<Vec2>) -> Self

Convenience constructor.

Source

pub fn bounds(&self) -> Rect

Axis-aligned bounding rect of the shape. For paths, computed from the point list (returns a zero rect for an empty path).

Source

pub fn as_mask_shape(&self) -> Option<MaskShape>

If this shape has an analytic SDF (rect / rounded / circle / ellipse), return it as a MaskShape so the existing mask / clip / privacy-blur / redaction / spotlight machinery can consume it directly. Returns None for Self::Path — callers should use the path-clip / path-mask-texture variants instead.

Source

pub fn as_path_points(&self) -> Option<&[Vec2]>

If this is a path, return the points slice. Returns None for analytic SDF shapes.

Trait Implementations§

Source§

impl Clone for VectorShape

Source§

fn clone(&self) -> VectorShape

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VectorShape

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for VectorShape

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for VectorShape

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,