Skip to main content

DashPattern

Struct DashPattern 

Source
pub struct DashPattern {
    pub on: f64,
    pub off: f64,
    pub phase: f64,
}
Expand description

The per-corner radii and dash-pattern vocabulary PaintScene’s own signatures name, re-exported from frust-scene so a widget calling PaintScene::fill_rounded_rect_radii/PaintScene::push_clip_rounded_radii/ PaintScene::stroke_path_dashed can name their arguments through the same paint surface it already paints through (mirrors the crate-root accesskit re-export). A stroke’s dash pattern: an on run, an off gap, and a phase offset into that repeating cycle — all lengths in the pre-transform coordinate space.

One on/off pair rather than an arbitrary-length array: it covers the dashed dividers/outlines/focus rings widgets ask for, stays Copy (so PathStyle and every command holding one stay Copy/allocation-free), and the render crate expands it into a [on, off] slice at encode time.

Fields§

§on: f64

Length of each painted dash.

§off: f64

Length of each gap between dashes.

§phase: f64

Distance into the on/off cycle the pattern starts at — animate this to march the dashes along the path.

Implementations§

Source§

impl DashPattern

Source

pub const fn new(on: f64, off: f64) -> DashPattern

An on/off cycle starting at phase 0.

Source

pub const fn with_phase(self, phase: f64) -> DashPattern

The same pattern offset by phase into its cycle.

Source

pub fn is_effective(&self) -> bool

Whether this pattern actually breaks a stroke into dashes.

A non-positive or non-finite length has no dashed interpretation (a zero off is a solid line; a zero on paints nothing, which a caller never means by “dashed”), so frust-render strokes such a path solid rather than feeding a degenerate cycle to the dash iterator. Additionally, a period (on + off) smaller than [DASH_PERIOD_EPSILON] is too dense to efficiently expand at encode time and is visually indistinguishable from a solid stroke anyway, so the pattern falls back to solid.

Trait Implementations§

Source§

impl Clone for DashPattern

Source§

fn clone(&self) -> DashPattern

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 Copy for DashPattern

Source§

impl Debug for DashPattern

Source§

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

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

impl PartialEq for DashPattern

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DashPattern

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.