Skip to main content

StrokeInputBatch

Struct StrokeInputBatch 

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

An ordered run of StrokeInputs.

Ink validates the whole batch up front: times must not go backwards, every input must report the same tool type, and the optional fields must be present on all of them or none.

Implementations§

Source§

impl StrokeInputBatch

Source

pub fn new(inputs: &[StrokeInput]) -> Result<Self>

Builds a batch from a slice of inputs.

Source

pub fn with_seed( inputs: &[StrokeInput], noise_seed: u32, base_paint_animation_phase: f32, ) -> Result<Self>

Builds a batch, choosing the seed for brushes with randomised noise and the starting phase for animated brush paints.

Source

pub fn empty() -> Self

An empty batch.

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn get(&self, index: usize) -> Option<StrokeInput>

The input at index, or None if it is past the end.

Source

pub fn push(&mut self, input: StrokeInput) -> Result<()>

Appends one input, which must be consistent with what is already here.

Source

pub fn extend_from_batch(&mut self, other: &StrokeInputBatch) -> Result<()>

Appends another batch.

Source

pub fn clear(&mut self)

Source

pub fn duration(&self) -> Duration

Time from the first input to the last.

Ink keeps times as f32 seconds, so this does not round-trip exactly: a batch built from 112ms of input reads back as 112.000003ms. Compare with a tolerance rather than for equality.

Source

pub fn tool_type(&self) -> ToolType

The tool every input in the batch reports.

Source

pub fn noise_seed(&self) -> u32

The seed used by brushes with randomised behaviour.

Source

pub fn iter(&self) -> impl Iterator<Item = StrokeInput> + '_

Iterates over the inputs, copying each one out as it goes.

Trait Implementations§

Source§

impl Clone for StrokeInputBatch

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 StrokeInputBatch

Source§

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

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

impl Drop for StrokeInputBatch

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

impl TryFrom<&[StrokeInput]> for StrokeInputBatch

Source§

type Error = Error

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

fn try_from(inputs: &[StrokeInput]) -> Result<Self>

Performs the conversion.

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.