Struct ParameterDescriptor 

pub struct ParameterDescriptor {
    pub id: u32,
    pub stable_id: String,
    pub name: String,
    pub kind: ParameterKind,
    pub min: f64,
    pub max: f64,
    pub default: f64,
    pub automatable: bool,
}

A single automatable plugin parameter and its value range.

Fields

id: u32

The parameter’s numeric id, unique within a plugin.

stable_id: String

The backend-stable identifier string.

name: String

The human-readable display name.

kind: ParameterKind

The value domain (ParameterKind).

min: f64

The inclusive minimum plain value.

max: f64

The inclusive maximum plain value.

default: f64

The default plain value, clamped into min..=max.

automatable: bool

Whether a host may automate this parameter.

Implementations

impl ParameterDescriptor

pub fn new( id: u32, stable_id: impl Into<String>, name: impl Into<String>, min: f64, max: f64, default: f64, ) -> Result<Self>

Builds a ParameterKind::Float, automatable parameter.

default is clamped into min..=max.

Errors

Returns an error when stable_id or name is empty after trimming, or when min exceeds max.

pub fn with_kind(self, kind: ParameterKind) -> Self

Returns the descriptor with its ParameterKind replaced.

pub fn plain_to_normalized(&self, value: f64) -> f64

Maps a plain value to the normalized 0.0..=1.0 range.

The input is clamped into min..=max first; a zero-width range maps to 0.0.

pub fn normalized_to_plain(&self, normalized: f64) -> f64

Maps a normalized 0.0..=1.0 value back to a plain value in min..=max.

The input is clamped into 0.0..=1.0 first.

Trait Implementations

impl Clone for ParameterDescriptor

fn clone(&self) -> ParameterDescriptor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParameterDescriptor

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

Formats the value using the given formatter.

impl PartialEq for ParameterDescriptor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParameterDescriptor