Skip to main content

EffectParamSpec

Struct EffectParamSpec 

Source
#[non_exhaustive]
pub struct EffectParamSpec { pub name: String, pub label: String, pub param_type: EffectParamType, pub default: EffectValue, pub min: Option<f32>, pub max: Option<f32>, pub step: Option<f32>, pub unit: EffectParamUnit, pub enum_values: Vec<String>, }
Expand description

One declared parameter of a built-in definition.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: String

The name a ClipEffect sets it by.

§label: String

A human-readable label.

§param_type: EffectParamType

The type of its values.

§default: EffectValue

The value used when a document leaves it out.

§min: Option<f32>

Inclusive minimum of each scalar component.

§max: Option<f32>

Inclusive maximum of each scalar component.

§step: Option<f32>

A suggested editing increment.

§unit: EffectParamUnit

How its value reads.

§enum_values: Vec<String>

The choices of an EffectParamType::Enum; an enum value is an index into them.

Implementations§

Source§

impl EffectParamSpec

Source

pub fn accepts(&self, value: &EffectValue) -> bool

Whether value has this parameter’s type and lies in its range, as the renderer requires of an authored value.

Source

pub const fn domain(&self) -> Domain

The range of each scalar component, as Self::accepts checks it.

Source

pub const fn takes_data(&self) -> bool

Whether the parameter can follow a data set, which only Float and Vec2 ones can.

Source

pub fn accepts_animation(&self, animation: &Animated<EffectValue>) -> bool

Whether every authored value of animation is accepted, or for a data binding whether the type takes data. Only keyframe values count, since interpolated overshoot is clamped.

Trait Implementations§

Source§

impl Clone for EffectParamSpec

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 EffectParamSpec

Source§

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

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

impl PartialEq for EffectParamSpec

Source§

fn eq(&self, other: &Self) -> 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 EffectParamSpec

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 = !

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.