Skip to main content

Path

Struct Path 

Source
pub struct Path {
    commands: Vec<PathCommand>,
}
Expand description

Owned path data — list of PathCommands plus consumer methods.

Fields§

§commands: Vec<PathCommand>

Implementations§

Source§

impl Path

Source

pub fn union_with(&self, other: &Path) -> Path

Fluent A ∪ B. Equivalent to combine(self, other, BooleanOp::Union, BoolOptions::default()).

Source

pub fn intersect_with(&self, other: &Path) -> Path

Fluent A ∩ B.

Source

pub fn cut(&self, other: &Path) -> Path

Fluent A − B. Named cut for Pixi-parity per the ticket.

Source

pub fn xor_with(&self, other: &Path) -> Path

Fluent A ⊕ B.

Source§

impl Path

Source

pub fn from_commands(commands: Vec<PathCommand>) -> Self

Construct from a raw command vector. Prefer PathBuilder for fluent construction.

Source

pub fn commands(&self) -> &[PathCommand]

Borrow the underlying commands.

Source

pub fn flatten_subpaths(&self, tolerance: f32) -> Vec<Vec<Vec2>>

Flatten Beziers to line segments per subpath, preserving MoveTo boundaries. Each MoveTo starts a new Vec<Vec2>; subsequent LineTo / QuadTo / CubicTo commands append into the current subpath; Close appends a final point back to the subpath’s start.

This is the multi-subpath variant of Path::flatten (M-BOOL.7 / AUT-168). Boolean ops, masks, and any consumer that needs to distinguish disjoint regions of a single Path (e.g. holes, multi-shape clips) should use this instead of the flat-concatenation Path::flatten.

tolerance semantics match Path::flatten. Empty paths return an empty Vec; paths with only a MoveTo return a single one-element subpath.

Source

pub fn flatten(&self, tolerance: f32) -> Vec<Vec2>

Flatten Beziers to line segments and return the resulting polygon (a Vec<Vec2>). tolerance is the maximum perpendicular distance from a control point to the chord before the curve subdivides further. NDC units; 0.005 is a reasonable default.

Open subpaths (no Close) end at the last point. Close adds a line back to the most recent MoveTo.

For consumers that need to distinguish individual subpaths (boolean ops, holes, multi-shape masks), use Path::flatten_subpaths.

Source

pub fn stroke_to_graphics( &self, width: f32, color: Color, tolerance: f32, ) -> Graphics

Rasterize this path as a stroked Graphics node. Each flattened segment becomes a Graphics::draw_line call. width is the stroke width in NDC units; tolerance controls flatness of curves.

Source

pub fn to_mask_polygon(&self, tolerance: f32) -> Vec<Vec2>

Convert to a crate::scene::VectorShape::Path for use as a mask via the path-mask machinery. Caller is responsible for keeping the vertex count under MAX_PATH_POINTS (32 vertices — see path_clip.wgsl). Anything beyond the cap is silently truncated by the path-mask shader.

Trait Implementations§

Source§

impl Clone for Path

Source§

fn clone(&self) -> Path

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 Path

Source§

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

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

impl PartialEq for Path

Source§

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

Auto Trait Implementations§

§

impl Freeze for Path

§

impl RefUnwindSafe for Path

§

impl Send for Path

§

impl Sync for Path

§

impl Unpin for Path

§

impl UnsafeUnpin for Path

§

impl UnwindSafe for Path

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,