Struct CommandInfo 

pub struct CommandInfo {
    pub command_name: Utf8CString,
    pub parent_command_index: c_int,
    pub frame_number: c_int,
    pub frame_time: c_float,
    pub instance_type: InstanceType,
    pub output_type: InstanceType,
    pub instance_handle: c_uint,
    pub output_handle: c_uint,
}

Available on crate feature studio only.

Describes a command replay command.

Fields

command_name: Utf8CString

Fully qualified C++ name of the API function for this command.

parent_command_index: c_int

Index of the command that created the instance this command operates on, or -1 if the command does not operate on any instance.

frame_number: c_int

Frame the command belongs to.

frame_time: c_float

Playback time at which this command will be executed.

instance_type: InstanceType

Type of object that this command uses as an instance.

output_type: InstanceType

Type of object that this command outputs.

instance_handle: c_uint

Original handle value of the instance.

output_handle: c_uint

Original handle value of the command output.

Implementations

impl CommandInfo

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

Create a safe CommandInfo struct from the FFI equivalent.

Safety

All string values from the FFI struct 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 CommandInfo

fn clone(&self) -> CommandInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandInfo

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

Formats the value using the given formatter.

impl From<&CommandInfo> for FMOD_STUDIO_COMMAND_INFO

fn from(value: &CommandInfo) -> Self

Converts to this type from the input type.