Skip to main content

Brush

Struct Brush 

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

A brush family together with a colour, a size and an epsilon.

size is the stroke width in stroke units. epsilon is the smallest distance Ink bothers to distinguish, also in stroke units; it controls how aggressively the generated mesh is simplified, and must be positive and no larger than size.

Implementations§

Source§

impl Brush

Source

pub fn new( family: &BrushFamily, color: Color, size: f32, epsilon: f32, ) -> Result<Self>

Builds a brush.

Fails with ErrorKind::InvalidArgument unless size and epsilon are both finite and positive and epsilon <= size.

Source

pub fn size(&self) -> f32

Stroke width in stroke units.

Source

pub fn epsilon(&self) -> f32

Smallest distance Ink distinguishes, in stroke units.

Source

pub fn color(&self) -> Color

The brush colour, gamma-encoded in the colour space Ink stored it in.

Source

pub fn color_in(&self, format: ColorFormat) -> Color

The brush colour in a chosen encoding.

Source

pub fn coat_count(&self) -> u32

How many coats this brush paints. Each coat becomes its own render group in the resulting geometry.

Source

pub fn family(&self) -> BrushFamily

A copy of the brush’s family.

Source

pub fn set_size(&mut self, size: f32) -> Result<()>

Changes the stroke width. Same constraints as Brush::new.

Source

pub fn set_epsilon(&mut self, epsilon: f32) -> Result<()>

Changes epsilon. Same constraints as Brush::new.

Source

pub fn set_color(&mut self, color: Color)

Changes the colour. Never invalidates geometry.

Source

pub fn set_family(&mut self, family: &BrushFamily)

Changes the brush family.

Trait Implementations§

Source§

impl Clone for Brush

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 Brush

Source§

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

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

impl Drop for Brush

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§

§

impl !Send for Brush

§

impl !Sync for Brush

§

impl Freeze for Brush

§

impl RefUnwindSafe for Brush

§

impl Unpin for Brush

§

impl UnsafeUnpin for Brush

§

impl UnwindSafe for Brush

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.