Struct DspParameterDescription

pub struct DspParameterDescription {
    pub kind: DspParameterType,
    pub name: Utf8CString,
    pub label: Utf8CString,
    pub description: Utf8CString,
}

Base structure for DSP parameter descriptions.

Fields

kind: DspParameterType

Parameter type.

name: Utf8CString

Parameter name.

label: Utf8CString

Parameter label.

description: Utf8CString

Parameter description.

Implementations

impl DspParameterDescription

pub unsafe fn from_ffi(value: FMOD_DSP_PARAMETER_DESC) -> Self

Create a safe DspParameterDescription struct from the FFI equivalent.

Safety

FMOD_DSP_PARAMETER_DESC::type_ must match the union value.

The strings FMOD_DSP_PARAMETER_DESC 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.

Panics

This function will panic if the description type is not valid.

Trait Implementations

impl Debug for DspParameterDescription

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

Formats the value using the given formatter.