Skip to main content

Vst3ParamInfo

Struct Vst3ParamInfo 

Source
pub struct Vst3ParamInfo {
    pub id: u32,
    pub stable_id: String,
    pub title: String,
    pub units: String,
    pub min: f64,
    pub max: f64,
    pub default: f64,
    pub automatable: bool,
}
Expand description

A VST3 parameter declaration.

Captures the host-facing identity and value range of one automatable parameter; to_parameter_descriptor lowers it into the shared plugin-core ParameterDescriptor.

Fields§

§id: u32

The numeric VST3 parameter id.

§stable_id: String

The stable string id used for persistence and lookup.

§title: String

The human-readable parameter title.

§units: String

The display units, empty when the parameter is unitless.

§min: f64

The minimum parameter value.

§max: f64

The maximum parameter value.

§default: f64

The default value, clamped into the min..=max range.

§automatable: bool

Whether the host may automate the parameter.

Implementations§

Source§

impl Vst3ParamInfo

Source

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

Builds a parameter, validating ids and range.

Requires non-empty stable_id and title and min <= max; default is clamped into the range, units starts empty, and automatable defaults to true. Returns an error when validation fails.

Source

pub fn to_parameter_descriptor(&self) -> Result<ParameterDescriptor>

Lowers this parameter into a plugin-core ParameterDescriptor with a Float kind.

Trait Implementations§

Source§

impl Clone for Vst3ParamInfo

Source§

fn clone(&self) -> Vst3ParamInfo

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 Vst3ParamInfo

Source§

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

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

impl PartialEq for Vst3ParamInfo

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Vst3ParamInfo

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.