#[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
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.name: StringThe name a ClipEffect sets it by.
label: StringA human-readable label.
param_type: EffectParamTypeThe type of its values.
default: EffectValueThe 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: EffectParamUnitHow 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
impl EffectParamSpec
Sourcepub fn accepts(&self, value: &EffectValue) -> bool
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.
Sourcepub const fn domain(&self) -> Domain
pub const fn domain(&self) -> Domain
The range of each scalar component, as Self::accepts checks it.
Sourcepub const fn takes_data(&self) -> bool
pub const fn takes_data(&self) -> bool
Whether the parameter can follow a data set, which only Float and Vec2 ones can.
Sourcepub fn accepts_animation(&self, animation: &Animated<EffectValue>) -> bool
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.