Struct IPLContextSettings 

#[repr(C)]
pub struct IPLContextSettings {
    pub version: IPLuint32,
    pub logCallback: IPLLogFunction,
    pub allocateCallback: IPLAllocateFunction,
    pub freeCallback: IPLFreeFunction,
    pub simdLevel: IPLSIMDLevel,
    pub flags: IPLContextFlags,
}

Settings used to create a context object.

Fields

version: IPLuint32

The API version used by the caller. Context creation will fail if phonon.dll does not implement a compatible version of the API. Typically, this should be set to STEAMAUDIO_VERSION.

logCallback: IPLLogFunction

(Optional) If non-NULL, Steam Audio will call this function to record log messages generated by certain operations.

allocateCallback: IPLAllocateFunction

(Optional) If non-NULL, Steam Audio will call this function whenever it needs to allocate memory.

freeCallback: IPLFreeFunction

(Optional) If non-NULL, Steam Audio will call this function whenever it needs to free memory.

simdLevel: IPLSIMDLevel

The maximum SIMD instruction set level that Steam Audio should use. Steam Audio automatically chooses the best instruction set to use based on the user’s CPU, but you can prevent it from using certain newer instruction sets using this parameter. For example, with some workloads, AVX512 instructions consume enough power that the CPU clock speed will be throttled, resulting in lower performance than expected. If you observe this in your application, set this parameter to IPL_SIMDLEVEL_AVX2 or lower.

flags: IPLContextFlags

Additional flags for modifying the behavior of the created context.

Trait Implementations

impl Clone for IPLContextSettings

fn clone(&self) -> IPLContextSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IPLContextSettings

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

Formats the value using the given formatter.

impl Copy for IPLContextSettings