Skip to main content

MaskShape

Enum MaskShape 

Source
#[non_exhaustive]
pub enum MaskShape { Rect { rect: Rect, }, RoundedRect { rect: Rect, radius: f32, }, Circle { center: Vec2, radius: f32, }, Ellipse { center: Vec2, half_extents: Vec2, }, }
Expand description

Shape of a clip / mask region.

Variants land issue-by-issue:

Later issues (AUT-35 freehand path) extend this enum further.

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. The renderer treats this as a RoundedRect with radius = 0 and routes through the same SDF pipeline.

Fields

§rect: Rect

Axis-aligned bounding rect, NDC coords.

§

RoundedRect

Rounded rectangle in NDC. rect is the axis-aligned bounding box, radius is the corner radius in NDC units (clamped at render-time to half the smaller side).

Fields

§rect: Rect

Axis-aligned bounding rect, NDC coords.

§radius: f32

Corner radius in NDC units.

§

Circle

Circle in NDC. The renderer treats this as a RoundedRect with a square bounding box and a corner radius equal to the half-extent — the rounded-rect SDF degenerates exactly to the circle SDF in that case (length(p) - r).

Fields

§center: Vec2

Center, NDC coords.

§radius: f32

Radius, NDC units.

§

Ellipse

Axis-aligned ellipse in NDC. half_extents is (a, b) of the implicit equation (x/a)^2 + (y/b)^2 = 1. The renderer uses a scaled-quadratic pseudo-SDF that’s anisotropic-correct and cheap (one length, one multiply); not Euclidean distance, but accurate enough for masking and AA.

Fields

§center: Vec2

Center, NDC coords.

§half_extents: Vec2

Half-extents (a, b), NDC units.

Implementations§

Source§

impl MaskShape

Source

pub fn rect(rect: Rect) -> Self

Convenience constructor for a sharp-corner rectangle.

Source

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

Convenience constructor for a rounded rectangle.

Source

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

Convenience constructor for a circle.

Source

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

Convenience constructor for an axis-aligned ellipse.

Source

pub fn bounds(self) -> Rect

The axis-aligned bounding rect of the mask.

Trait Implementations§

Source§

impl Clone for MaskShape

Source§

fn clone(&self) -> MaskShape

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 MaskShape

Source§

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

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

impl PartialEq for MaskShape

Source§

fn eq(&self, other: &MaskShape) -> 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 Copy for MaskShape

Source§

impl StructuralPartialEq for MaskShape

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,