Skip to main content

ParamDescriptor

Struct ParamDescriptor 

Source
pub struct ParamDescriptor {
    pub id: u32,
    pub name: &'static str,
    pub min: f64,
    pub max: f64,
    pub default: f64,
    pub unit: ParamUnit,
    pub flags: ParamFlags,
    pub step: f64,
    pub group: Option<u32>,
    pub help: &'static str,
}
Expand description

Describes a single automatable parameter.

This is the self-describing interface that lets any UI (TUI, web, etc.) enumerate and control a processor’s parameters without hardcoding.

Fields§

§id: u32§name: &'static str

Human-readable label for automation UIs.

§min: f64

Minimum allowed value (inclusive unless a processor documents otherwise).

§max: f64

Maximum allowed value (inclusive unless documented otherwise).

§default: f64

Value after Processor::reset or construction.

§unit: ParamUnit

How to display and interpret the number (e.g. dB vs linear gain).

§flags: ParamFlags

Knob curve and range shape hints.

§step: f64

Coarse nudge increment for arrow-key editing. UIs use step / 10 for fine adjustments. Zero means “let the UI pick a sensible default”.

§group: Option<u32>

Which ParamGroup this parameter belongs to, if any.

§help: &'static str

Short help text shown in info panels when hovering this parameter.

Trait Implementations§

Source§

impl Clone for ParamDescriptor

Source§

fn clone(&self) -> ParamDescriptor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParamDescriptor

Source§

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

Formats the value using the given formatter. Read more

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