Enum AppMode

#[repr(u32)]
pub enum AppMode {
    None = 0,
    XR = 1,
    Simulator = 2,
    Window = 3,
    Offscreen = 4,
}

Which operation mode should we use for this app? Default is XR, and by default the app will fall back to Simulator if XR fails or is unavailable. https://stereokit.net/Pages/StereoKit/AppMode.html

see also: SkSettings::mode

Variants

None = 0

No mode has been specified, default behavior will be used. StereoKit will pick XR in this case.

XR = 1

Creates an OpenXR or WebXR instance, and drives display/input through that.

Simulator = 2

Creates a flat window, and simulates some XR functionality. Great for development and debugging.

Window = 3

Creates a flat window and displays to that, but doesn’t simulate XR at all. You will need to control your own camera here. This can be useful if using StereoKit for non-XR 3D applications.

Offscreen = 4

No display at all! StereoKit won’t even render to a texture unless requested to. This may be good for running tests on a server, or doing graphics related tool or CLI work.

Trait Implementations

impl Clone for AppMode

fn clone(&self) -> AppMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppMode

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

Formats the value using the given formatter.

impl PartialEq for AppMode

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

impl Eq for AppMode

impl StructuralPartialEq for AppMode