Package org.lwjgl.openxr

Class METAPassthroughPreferences

java.lang.Object

org.lwjgl.openxr.METAPassthroughPreferences

public class METAPassthroughPreferences
extends Object

The XR_META_passthrough_preferences extension.

This extension provides applications with access to system preferences concerning passthrough. For more information on how applications can control the display of passthrough, see XR_FB_passthrough.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_META_PASSTHROUGH_PREFERENCES_EXTENSION_NAME	The extension name.
static final int	XR_META_passthrough_preferences_SPEC_VERSION	The extension specification version.
static final int	XR_PASSTHROUGH_PREFERENCE_DEFAULT_TO_ACTIVE_BIT_META	XrPassthroughPreferenceFlagBitsMETA - XrPassthroughPreferenceFlagBitsMETA
static final int	XR_TYPE_PASSTHROUGH_PREFERENCES_META	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrGetPassthroughPreferencesMETA(XrSession session, long preferences)	Unsafe version of: GetPassthroughPreferencesMETA
static int	xrGetPassthroughPreferencesMETA(XrSession session, XrPassthroughPreferencesMETA preferences)	Get passthrough preferences.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_META_passthrough_preferences_SPEC_VERSION

public static final int XR_META_passthrough_preferences_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_META_PASSTHROUGH_PREFERENCES_EXTENSION_NAME

public static final String XR_META_PASSTHROUGH_PREFERENCES_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_PREFERENCES_META

public static final int XR_TYPE_PASSTHROUGH_PREFERENCES_META

Extends XrStructureType.

See Also:

• Constant Field Values

XR_PASSTHROUGH_PREFERENCE_DEFAULT_TO_ACTIVE_BIT_META

public static final int XR_PASSTHROUGH_PREFERENCE_DEFAULT_TO_ACTIVE_BIT_META

XrPassthroughPreferenceFlagBitsMETA - XrPassthroughPreferenceFlagBitsMETA

Flag Descriptions

• PASSTHROUGH_PREFERENCE_DEFAULT_TO_ACTIVE_BIT_META — Indicates that the runtime recommends apps to default to a mixed reality experience with passthrough (if supported).

See Also:

• Constant Field Values

Method Details

nxrGetPassthroughPreferencesMETA

public static int nxrGetPassthroughPreferencesMETA(XrSession session,
 long preferences)

Unsafe version of: GetPassthroughPreferencesMETA

xrGetPassthroughPreferencesMETA

public static int xrGetPassthroughPreferencesMETA(XrSession session,
 XrPassthroughPreferencesMETA preferences)

Get passthrough preferences.

C Specification

The GetPassthroughPreferencesMETA function is defined as:

 XrResult xrGetPassthroughPreferencesMETA(
     XrSession                                   session,
     XrPassthroughPreferencesMETA*               preferences);

Description

An application can call GetPassthroughPreferencesMETA to retrieve passthrough-related preferences from the system.

Valid Usage (Implicit)

• The XR_META_passthrough_preferences extension must be enabled prior to calling GetPassthroughPreferencesMETA
• session must be a valid XrSession handle
• preferences must be a pointer to an XrPassthroughPreferencesMETA structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST

See Also

XrPassthroughPreferencesMETA

Parameters:

session - the XrSession.

preferences - points to an instance of XrPassthroughPreferencesMETA structure, that will be filled with returned information