Skip to main content

Stroke

Struct Stroke 

Source
pub struct Stroke { /* private fields */ }
Expand description

A finished stroke: the input, the brush, and the geometry generated from the two.

Geometry is organised as one render group per brush coat, each holding one or more meshes. Ink splits a coat into several meshes when it has more vertices than a single 16-bit index buffer can address, so a renderer should loop over mesh_count rather than assume there is one.

Implementations§

Source§

impl Stroke

Source

pub fn new(brush: &Brush, inputs: &StrokeInputBatch) -> Self

Generates a stroke from a brush and a complete run of input.

Source

pub fn from_brush(brush: &Brush) -> Self

An empty stroke carrying just a brush.

Source

pub fn input_duration(&self) -> Duration

Total time covered by the stroke’s input.

Source

pub fn brush(&self) -> Brush

A copy of the brush the stroke was drawn with.

Source

pub fn inputs(&self) -> StrokeInputBatch

A copy of the input the stroke was generated from.

Source

pub fn render_group_count(&self) -> u32

Number of render groups, one per brush coat.

Source

pub fn mesh_count(&self, group_index: u32) -> u32

Number of meshes in one render group.

Source

pub fn mesh(&self, group_index: u32, mesh_index: u32) -> Mesh

One mesh. Out-of-range indices give an empty mesh.

Source

pub fn meshes(&self) -> Vec<Mesh>

Every mesh in the stroke, in the order they should be drawn.

Source

pub fn bounds(&self) -> Option<Rect>

Bounding box of the whole stroke, or None when it has no geometry.

Trait Implementations§

Source§

impl Clone for Stroke

Source§

fn clone(&self) -> Self

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 Stroke

Source§

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

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

impl Drop for Stroke

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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> 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.