Package org.lwjgl.openxr

Class XR11

java.lang.Object

org.lwjgl.openxr.XR11

public class XR11
extends Object

The core OpenXR 1.1 functionality.

OpenXR version 1.1 promoted a number of key extensions into the core API:

• KHR_locate_spaces
• KHR_maintenance1
• EXT_hp_mixed_reality_controller
• EXT_local_floor
• EXT_palm_pose
• EXT_samsung_odyssey_controller
• EXT_uuid
• BD_controller_interaction
• HTC_vive_cosmos_controller_interaction
• HTC_vive_focus3_controller_interaction
• ML_ml2_controller_interaction
• VARJO_quad_views

Field Summary

Fields

Modifier and Type	Field	Description
static final long	XR_API_VERSION_1_1	The version of the OpenXR 1.1 API.
static final int	XR_ERROR_EXTENSION_DEPENDENCY_NOT_ENABLED	Extends XrResult.
static final int	XR_ERROR_PERMISSION_INSUFFICIENT	Extends XrResult.
static final int	XR_REFERENCE_SPACE_TYPE_LOCAL_FLOOR	Extends XrReferenceSpaceType.
static final int	XR_TYPE_SPACE_LOCATIONS	Extends XrStructureType.
static final int	XR_TYPE_SPACE_VELOCITIES	Extends XrStructureType.
static final int	XR_TYPE_SPACES_LOCATE_INFO	Extends XrStructureType.
static final int	XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO_WITH_FOVEATED_INSET	Extends XrViewConfigurationType.

Method Summary

Modifier and Type	Method	Description
static int	nxrLocateSpaces(XrSession session, long locateInfo, long spaceLocations)	Unsafe version of: LocateSpaces
static int	xrLocateSpaces(XrSession session, XrSpacesLocateInfo locateInfo, XrSpaceLocations spaceLocations)	Locate an array of spaces.

Methods inherited from class java.lang.Object

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

Field Details

XR_ERROR_EXTENSION_DEPENDENCY_NOT_ENABLED

public static final int XR_ERROR_EXTENSION_DEPENDENCY_NOT_ENABLED

Extends XrResult.

Enum values:

• ERROR_EXTENSION_DEPENDENCY_NOT_ENABLED
• ERROR_PERMISSION_INSUFFICIENT

See Also:

• Constant Field Values

XR_ERROR_PERMISSION_INSUFFICIENT

public static final int XR_ERROR_PERMISSION_INSUFFICIENT

Extends XrResult.

Enum values:

• ERROR_EXTENSION_DEPENDENCY_NOT_ENABLED
• ERROR_PERMISSION_INSUFFICIENT

See Also:

• Constant Field Values

XR_TYPE_SPACES_LOCATE_INFO

public static final int XR_TYPE_SPACES_LOCATE_INFO

Extends XrStructureType.

Enum values:

• TYPE_SPACES_LOCATE_INFO
• TYPE_SPACE_LOCATIONS
• TYPE_SPACE_VELOCITIES

See Also:

• Constant Field Values

XR_TYPE_SPACE_LOCATIONS

public static final int XR_TYPE_SPACE_LOCATIONS

Extends XrStructureType.

Enum values:

• TYPE_SPACES_LOCATE_INFO
• TYPE_SPACE_LOCATIONS
• TYPE_SPACE_VELOCITIES

See Also:

• Constant Field Values

XR_TYPE_SPACE_VELOCITIES

public static final int XR_TYPE_SPACE_VELOCITIES

Extends XrStructureType.

Enum values:

• TYPE_SPACES_LOCATE_INFO
• TYPE_SPACE_LOCATIONS
• TYPE_SPACE_VELOCITIES

See Also:

• Constant Field Values

XR_REFERENCE_SPACE_TYPE_LOCAL_FLOOR

public static final int XR_REFERENCE_SPACE_TYPE_LOCAL_FLOOR

Extends XrReferenceSpaceType.

See Also:

• Constant Field Values

XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO_WITH_FOVEATED_INSET

public static final int XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO_WITH_FOVEATED_INSET

Extends XrViewConfigurationType.

See Also:

• Constant Field Values

XR_API_VERSION_1_1

public static final long XR_API_VERSION_1_1

The version of the OpenXR 1.1 API.

The "major" and "minor" components are always 1.1, while the "patch" component matches CURRENT_API_VERSION.

Method Details

nxrLocateSpaces

public static int nxrLocateSpaces(XrSession session,
 long locateInfo,
 long spaceLocations)

Unsafe version of: LocateSpaces

xrLocateSpaces

public static int xrLocateSpaces(XrSession session,
 XrSpacesLocateInfo locateInfo,
 XrSpaceLocations spaceLocations)

Locate an array of spaces.

C Specification

Applications can use LocateSpaces function to locate an array of spaces.

The LocateSpaces function is defined as:

 XrResult xrLocateSpaces(
     XrSession                                   session,
     const XrSpacesLocateInfo*                   locateInfo,
     XrSpaceLocations*                           spaceLocations);

Description

LocateSpaces provides the physical location of one or more spaces in a base space at a specified time, if currently known by the runtime.

The XrSpacesLocateInfo::time, the XrSpacesLocateInfo::baseSpace, and each space in XrSpacesLocateInfo::spaces, in the locateInfo parameter, all follow the same specifics as the corresponding inputs to the LocateSpace function.

Valid Usage (Implicit)

• session must be a valid XrSession handle
• locateInfo must be a pointer to a valid XrSpacesLocateInfo structure
• spaceLocations must be a pointer to an XrSpaceLocations 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
• ERROR_SIZE_INSUFFICIENT
• ERROR_TIME_INVALID

See Also

XrSpaceLocations, XrSpacesLocateInfo

Parameters:

session - an XrSession handle previously created with CreateSession.

locateInfo - a pointer to an XrSpacesLocateInfo that provides the input information to locate spaces.

spaceLocations - a pointer to an XrSpaceLocations for the runtime to return the locations of the specified spaces in the base space.