Struct PHASECullOption 

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

Available on crate feature PHASETypes only.

Cull option.

Determines what the engine should do when a sound asset becomes cullable.

If cullable, the sound asset will stop. Note that this can occur before or during playback.

If cullable, the sound asset will be put to sleep. Upon waking, start playback at the beginning.

If cullable, the sound asset will be put to sleep. Upon waking, start playback at random offset.

If cullable, the sound asset will be put to sleep. Upon waking, start playback at realtime offset.

If cullable, continue playback, even if the sound is inaudible.

See also Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl PHASECullOption

pub const Terminate: Self

pub const SleepWakeAtZero: Self

pub const SleepWakeAtRandomOffset: Self

pub const SleepWakeAtRealtimeOffset: Self

pub const DoNotCull: Self

Trait Implementations

impl Clone for PHASECullOption

fn clone(&self) -> PHASECullOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PHASECullOption

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

Formats the value using the given formatter.

impl Encode for PHASECullOption

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for PHASECullOption

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 PHASECullOption

fn cmp(&self, other: &PHASECullOption) -> 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 PHASECullOption

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

fn partial_cmp(&self, other: &PHASECullOption) -> 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 PHASECullOption

const ENCODING_REF: Encoding

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

impl Copy for PHASECullOption

impl Eq for PHASECullOption

impl StructuralPartialEq for PHASECullOption