Enum StandbyMode

#[repr(C)]
pub enum StandbyMode {
    Default = 0,
    Pause = 1,
    Slow = 2,
    None = 3,
}

When the device StereoKit is running on goes into standby mode, how should StereoKit react? Typically the app should pause, stop playing sound, and consume as little power as possible, but some scenarios such as multiplayer games may need the app to continue running. https://stereokit.net/Pages/StereoKit/StandbyMode.html

see also SkSettings::standby_mode

Variants

Default = 0

This will let StereoKit pick a mode based on its own preferences. On v0.3 and lower, this will be Slow, and on v0.4 and higher, this will be Pause.

Pause = 1

The entire main thread will pause, and wait until the device has come out of standby. This is the most power efficient mode for the device to take when the device is in standby, and is recommended for the vast majority of apps. This will also disable sound.

Slow = 2

The main thread will continue to execute, but with 100ms sleeps each frame. This allows the app to continue polling and processing, but reduces power consumption by throttling a bit. This will not disable sound. In the Simulator, this will behave as Slow.

None = 3

The main thread will continue to execute, but with a very short sleep each frame. This allows the app to continue polling and processing, but without flooding the CPU with polling work while vsync is no longer the throttle. This will not disable sound.

Trait Implementations

impl Clone for StandbyMode

fn clone(&self) -> StandbyMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StandbyMode

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

Formats the value using the given formatter.

impl PartialEq for StandbyMode

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

impl Eq for StandbyMode

impl StructuralPartialEq for StandbyMode