Struct ParameterDescription 

pub struct ParameterDescription {
    pub name: Utf8CString,
    pub id: ParameterID,
    pub minimum: c_float,
    pub maximum: c_float,
    pub default_value: c_float,
    pub kind: ParameterKind,
    pub flags: ParameterFlags,
    pub guid: Guid,
}

Available on crate feature studio only.

Describes an event parameter.

Fields

name: Utf8CString

The parameter’s name.

id: ParameterID

The parameter’s id.

minimum: c_float

The parameter’s minimum value.

maximum: c_float

The parameter’s maximum value.

default_value: c_float

The parameter’s default value.

kind: ParameterKind

The parameter’s type.

flags: ParameterFlags

The parameter’s behavior flags.

guid: Guid

The parameter’s Guid.

Implementations

impl ParameterDescription

pub unsafe fn from_ffi( value: FMOD_STUDIO_PARAMETER_DESCRIPTION, ) -> ParameterDescription

Create a safe ParameterDescription struct from the FFI equivalent.

Safety

The name from FMOD_STUDIO_PARAMETER_DESCRIPTION must be a null-terminated and must be valid for reads of bytes up to and including the nul terminator.

See Utf8CStr::from_ptr_unchecked for more information.

Trait Implementations

impl Clone for ParameterDescription

fn clone(&self) -> ParameterDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterDescription

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

Formats the value using the given formatter.

impl From<&ParameterDescription> for FMOD_STUDIO_PARAMETER_DESCRIPTION

fn from(value: &ParameterDescription) -> Self

Converts to this type from the input type.

impl PartialEq for ParameterDescription

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