Enum OriginMode

#[repr(u32)]
pub enum OriginMode {
    Local = 0,
    Floor = 1,
    Stage = 2,
}

This describes where the origin of the application should be. While these origins map closely to OpenXR features, not all runtimes support each feature. StereoKit will provide reasonable fallback behavior in the event the origin mode isn’t directly supported. https://stereokit.net/Pages/StereoKit/OriginMode.html

se also SkSettings::origin crate::system::World::get_origin_mode

Variants

Local = 0

Default value : The origin will be at the location of the user’s head when the application starts, facing the same direction as the user. This mode is available on all runtimes, and will never fall back to another mode! However, due to variances in underlying behavior, StereoKit may introduce an origin offset to ensure consistent behavior.

Floor = 1

The origin will be at the floor beneath where the user starts, facing the direction of the user. If this mode is not natively supported, StereoKit will use the stage mode with an offset. If stage mode is unavailable, it will fall back to local mode with a -1.5 Y axis offset.

Stage = 2

The origin will be at the center of a safe play area or stage that the user or OS has defined, and will face one of the edges of the play area. If this mode is not natively supported, StereoKit will use the floor origin mode. If floor mode is unavailable, it will fall back to local mode with a -1.5 Y axis offset.

Trait Implementations

impl Clone for OriginMode

fn clone(&self) -> OriginMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OriginMode

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

Formats the value using the given formatter.

impl PartialEq for OriginMode

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

impl Eq for OriginMode

impl StructuralPartialEq for OriginMode