Struct ParamInfo

pub struct ParamInfo {
    pub id: ClapId,
    pub flags: u32,
    pub name: String,
    pub module: String,
    pub min_value: f64,
    pub max_value: f64,
    pub default_value: f64,
}

Describes a parameter.

Fields

id: ClapId

Stable parameter identifier, it must never change.

flags: u32

name: String

The display name. eg: “Volume”. This does not need to be unique. Do not include the module text in this. The host should concatenate/format the module + name in the case where showing the name alone would be too vague.

module: String

min_value: f64

Minimum plain value. Must be finite.

max_value: f64

Maximum plain value. Must be finite.

default_value: f64

Default plain value. Must be in [min, max] range.

Implementations

impl ParamInfo

pub unsafe fn try_from_unchecked(value: clap_param_info) -> Result<Self, Error>

Safety

The values fields: ‘name’ and ‘module’ must be valid, null-terminated C strings.

Trait Implementations

impl Clone for ParamInfo

fn clone(&self) -> ParamInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamInfo

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

Formats the value using the given formatter.

impl PartialEq for ParamInfo

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