Struct AdvancedSettings

pub struct AdvancedSettings {
    pub command_queue_size: c_uint,
    pub handle_initial_size: c_uint,
    pub studio_update_period: c_int,
    pub idle_sample_data_pool_size: c_int,
    pub streaming_schedule_delay: c_uint,
    pub encryption_key: Option<Utf8CString>,
}

Available on crate feature studio only.

Settings for advanced features like configuring memory and cpu usage.

Fields

command_queue_size: c_uint

Command queue size for studio async processing.

handle_initial_size: c_uint

Initial size to allocate for handles. Memory for handles will grow as needed in pages.

studio_update_period: c_int

Update period of Studio when in async mode, in milliseconds. Will be quantized to the nearest multiple of mixer duration.

idle_sample_data_pool_size: c_int

Size in bytes of sample data to retain in memory when no longer used, to avoid repeated disk I/O. Use -1 to disable.

streaming_schedule_delay: c_uint

Specify the schedule delay for streams, in samples. Lower values can reduce latency when scheduling events containing streams but may cause scheduling issues if too small.

encryption_key: Option<Utf8CString>

Specify the key for loading sounds from encrypted banks.

Implementations

impl AdvancedSettings

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

Create a safe AdvancedSettings struct from the FFI equivalent.

Safety

The encryption key from FMOD_STUDIO_ADVANCEDSETTINGS 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 AdvancedSettings

fn clone(&self) -> AdvancedSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdvancedSettings

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

Formats the value using the given formatter.

impl Default for AdvancedSettings

fn default() -> AdvancedSettings

Returns the “default value” for a type.

impl From<&AdvancedSettings> for FMOD_STUDIO_ADVANCEDSETTINGS

fn from(value: &AdvancedSettings) -> Self

Converts to this type from the input type.

impl PartialEq for AdvancedSettings

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

impl StructuralPartialEq for AdvancedSettings