org.lwjgl.openxr.EXTUserPresence Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lwjgl-openxr Show documentation

A royalty-free, open standard that provides high-performance access to Augmented Reality (AR) and Virtual Reality (VR)—collectively known as XR—platforms and devices.

There is a newer version: 3.3.6

Show newest version

/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.openxr;

/**
 * The XR_EXT_user_presence extension.
 * 
 * This extension introduces a new event to notify when the system detected the change of user presence, such as when the user has taken off or put on an XR headset.
 * 
 * This event is typically used by an XR applications with non-XR experiences outside of the XR headset. For instance, some applications pause the game logic or video playback until the user puts on the headset, displaying an instructional message to the user in the mirror window on the desktop PC monitor. As another example, the application might use this event to disable a head-tracking driven avatar in an online meeting when the user has taken off the headset.
 * 
 * The user presence is fundamentally decoupled from the session lifecycle. Although the core spec for {@code XrSessionState} hinted potential correlation between the session state and user presence, in practice, such a connection may not consistently hold across various runtimes. Application should avoid relying on assumptions regarding these relationships between session state and user presence, instead, they should utilize this extension to reliably obtain user presence information.
 */
public final class EXTUserPresence {

    /** The extension specification version. */
    public static final int XR_EXT_user_presence_SPEC_VERSION = 1;

    /** The extension name. */
    public static final String XR_EXT_USER_PRESENCE_EXTENSION_NAME = "XR_EXT_user_presence";

    /**
     * Extends {@code XrStructureType}.
     * 
     * Enum values:
     * 
     * 
     * {@link #XR_TYPE_EVENT_DATA_USER_PRESENCE_CHANGED_EXT TYPE_EVENT_DATA_USER_PRESENCE_CHANGED_EXT}
     * {@link #XR_TYPE_SYSTEM_USER_PRESENCE_PROPERTIES_EXT TYPE_SYSTEM_USER_PRESENCE_PROPERTIES_EXT}
     * 
     */
    public static final int
        XR_TYPE_EVENT_DATA_USER_PRESENCE_CHANGED_EXT = 1000470000,
        XR_TYPE_SYSTEM_USER_PRESENCE_PROPERTIES_EXT  = 1000470001;

    private EXTUserPresence() {}

}