Struct PHASEUpdateMode 

#[repr(transparent)]
pub struct PHASEUpdateMode(pub NSInteger);

Available on crate feature PHASETypes only.

Update mode for the engine.

The engine update mode determines the rate at which the engine consumes client commands, performs internal updates, and calls any registered handlers. All API calls to the engine are queued until the engine updates. The engine update mode determines if the engine or the application triggers the consumption of API commands.

Note: The update mode does not affect the Audio IO Thread or rendering, in general. The Audio IO Thread always runs in the background, independent of the update mode.

The engine will internally consume client commands at a rate opaque to the client. In general, automatic update mode is meant for simpler applications that just want to play sounds, without having to maintain a strict update loop. Due to the fact that the engine consumes client commands at its own internal rate, the client is never guaranteed that two independent commands will synchronize.

When an application requires precise synchronization of API calls with the main update, manual mode is the best choice. In this mode, clients will need to call [PHASEEngine update] periodically to process new commands, perform internal updates, and receive callbacks. The rate at which the client calls update should at least match the rate at which other time-critical subsystems are updated, such graphics rendering etc. API calls between calls to [PHASEEngine update] are guaranteed to be synchronized. For example, the client can move two sources into place, request to start two sound events (one per source), then call [PHASEEngine update]. These calls will be guaranteed to be processed at the same time.

See also Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl PHASEUpdateMode

pub const Automatic: Self

pub const Manual: Self

Trait Implementations

impl Clone for PHASEUpdateMode

fn clone(&self) -> PHASEUpdateMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PHASEUpdateMode

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

Formats the value using the given formatter.

impl Encode for PHASEUpdateMode

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for PHASEUpdateMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PHASEUpdateMode

fn cmp(&self, other: &PHASEUpdateMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PHASEUpdateMode

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

fn partial_cmp(&self, other: &PHASEUpdateMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for PHASEUpdateMode

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for PHASEUpdateMode

impl Eq for PHASEUpdateMode

impl StructuralPartialEq for PHASEUpdateMode