Skip to main content

Paint

Enum Paint 

Source
pub enum Paint {
    Solid(Color),
    LinearGradient(LinearGradient),
    RadialGradient(RadialGradient),
    Blend(Vec<(Paint, f64)>),
    MeshGradient(MeshGradient),
}
Expand description

Describes how to fill vector geometry. Solid fills interpolate their RGBA channels. Other pairs crossfade sampled paints in premultiplied RGBA, preserving each gradient’s geometry and stops.

Variants§

§

Solid(Color)

A single solid color.

§

LinearGradient(LinearGradient)

A linear gradient.

§

RadialGradient(RadialGradient)

A radial gradient.

§

Blend(Vec<(Paint, f64)>)

A weighted paint mixture produced by interpolation. Weights are finite, nonnegative, and sum to one. Use Paint::blend to normalize weights, flatten nested mixtures, and combine repeated endpoints.

§

MeshGradient(MeshGradient)

A row-connected bicubic field with independently positioned colored anchors.

Implementations§

Source§

impl Paint

Source

pub fn blend(terms: Vec<(Paint, f64)>) -> Paint

Constructs a normalized mixture of paints. Nested mixtures are flattened and identical endpoints merged, so repeated interruptions between a fixed set of themes do not accumulate a history of blend nodes. Nonpositive or nonfinite weights are ignored; an empty mixture is transparent.

Sampling cost grows with the number of distinct endpoints still visible. A completed interpolation returns its destination paint directly.

Source

pub fn representative_color(&self) -> Color

Representative solid color for native text, which currently uses the first stop of a gradient. Mixtures crossfade those representative colors.

Source

pub fn to_unit_point(_: (Size, Size), _: (f64, f64)) -> UnitPoint

Source

pub fn to_piet_gradient_stops(stops: Vec<GradientStop>) -> Vec<GradientStop>

Source

pub fn linearGradient( start: (Size, Size), end: (Size, Size), stops: Vec<GradientStop>, ) -> Paint

Constructs a linear gradient paint.

Pax templates should normally use @gradient. When this helper is needed explicitly, pass start and end as [x, y] lists.

Source

pub fn with_alpha_factor(&self, factor: f64) -> Paint

Returns a copy of this paint with alpha multiplied by factor.

Source

pub fn max_alpha_0_1(&self) -> f64

Returns a conservative upper bound for this paint’s alpha. For mixtures, endpoint maxima need not occur at the same point.

Source

pub fn coverage_alpha_0_1(&self) -> f64

Estimates the alpha coverage contributed by this fill.

Trait Implementations§

Source§

impl Clone for Paint

Source§

fn clone(&self) -> Paint

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 CoercionRules for Paint

Source§

fn try_coerce(pax_value: PaxValue) -> Result<Paint, String>

Attempts to coerce value into Self.
Source§

fn allows_singleton_stack() -> bool

Opts appearance layers into scalar-to-singleton stack conversion. Ordinary vector values remain list-only.
Source§

fn is_identity_roundtrip() -> bool

Whether cloning Self preserves the semantics of converting that clone through ToPaxValue and back with try_coerce. Read more
Source§

impl Debug for Paint

Source§

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

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

impl Default for Paint

Source§

fn default() -> Paint

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Paint

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Paint, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<Color> for Paint

Source§

fn from(color: Color) -> Paint

Converts to this type from the input type.
Source§

impl From<Paint> for Fill

Source§

fn from(paint: Paint) -> Fill

Converts to this type from the input type.
Source§

impl From<Paint> for Stroke

Source§

fn from(paint: Paint) -> Stroke

Converts to this type from the input type.
Source§

impl Hash for Paint

Source§

fn hash<H>(&self, state: &mut H)
where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl HelperFunctions for Paint

Source§

fn register_all_functions()

Registers all helper functions for this type.
Source§

impl Interpolatable for Paint

Source§

fn interpolate(&self, other: &Paint, t: f64) -> Paint

Interpolates this value toward other at time t on the unit interval. Read more
Source§

impl PartialEq for Paint

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for Paint

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Paint

Source§

impl ToPaxValue for Paint

Source§

fn to_pax_value(self) -> PaxValue

Converts this value into a PaxValue.
Source§

fn nested_properties(&self) -> Vec<UntypedProperty>

Live properties read when snapshotting a compound value for PAXEL. Adapters observe these as well as the containing property.
Source§

fn to_pax_value_in_graph(self) -> PaxValue
where Self: Sized,

Converts against owner-thread graph views, including nested generated property fields. Requires an entered property graph for shared fields. Ordinary Self::to_pax_value reads published value snapshots.

Auto Trait Implementations§

§

impl Freeze for Paint

§

impl RefUnwindSafe for Paint

§

impl Send for Paint

§

impl Sync for Paint

§

impl Unpin for Paint

§

impl UnsafeUnpin for Paint

§

impl UnwindSafe for Paint

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> PropertyValue for T
where T: Default + Clone + Interpolatable + 'static,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> RoundFrom<T> for T

Source§

fn round_from(x: T) -> T

Performs the conversion.
Source§

impl<T, U> RoundInto<U> for T
where U: RoundFrom<T>,

Source§

fn round_into(self) -> U

Performs the conversion.
Source§

impl<T> SharedPropertyValue for T
where T: PropertyValue + Send + Sync,

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

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,