Package org.lwjgl.openxr

Class HTCAnchor

java.lang.Object

org.lwjgl.openxr.HTCAnchor

public class HTCAnchor
extends Object

The XR_HTC_anchor extension.

This extension allows an application to create a spatial anchor to track a point in the physical environment. The runtime adjusts the pose of the anchor over time to align it with the real world.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_NOT_AN_ANCHOR_HTC	Extends XrResult.
static final String	XR_HTC_ANCHOR_EXTENSION_NAME	The extension name.
static final int	XR_HTC_anchor_SPEC_VERSION	The extension specification version.
static final int	XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC	XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC
static final int	XR_TYPE_SPATIAL_ANCHOR_CREATE_INFO_HTC	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_ANCHOR_PROPERTIES_HTC	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateSpatialAnchorHTC(XrSession session, long createInfo, long anchor)	Unsafe version of: CreateSpatialAnchorHTC
static int	nxrGetSpatialAnchorNameHTC(XrSpace anchor, long name)	Unsafe version of: GetSpatialAnchorNameHTC
static int	xrCreateSpatialAnchorHTC(XrSession session, XrSpatialAnchorCreateInfoHTC createInfo, org.lwjgl.PointerBuffer anchor)	Creates a spatial anchor.
static int	xrGetSpatialAnchorNameHTC(XrSpace anchor, XrSpatialAnchorNameHTC name)	Get name of a spatial anchor.

Methods inherited from class java.lang.Object

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

Field Details

XR_HTC_anchor_SPEC_VERSION

public static final int XR_HTC_anchor_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_HTC_ANCHOR_EXTENSION_NAME

public static final String XR_HTC_ANCHOR_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC

public static final int XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC

XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_ANCHOR_PROPERTIES_HTC

public static final int XR_TYPE_SYSTEM_ANCHOR_PROPERTIES_HTC

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_ANCHOR_PROPERTIES_HTC
• TYPE_SPATIAL_ANCHOR_CREATE_INFO_HTC

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_ANCHOR_CREATE_INFO_HTC

public static final int XR_TYPE_SPATIAL_ANCHOR_CREATE_INFO_HTC

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_ANCHOR_PROPERTIES_HTC
• TYPE_SPATIAL_ANCHOR_CREATE_INFO_HTC

See Also:

• Constant Field Values

XR_ERROR_NOT_AN_ANCHOR_HTC

public static final int XR_ERROR_NOT_AN_ANCHOR_HTC

Extends XrResult.

See Also:

• Constant Field Values

Method Details

nxrCreateSpatialAnchorHTC

public static int nxrCreateSpatialAnchorHTC(XrSession session,
 long createInfo,
 long anchor)

Unsafe version of: CreateSpatialAnchorHTC

xrCreateSpatialAnchorHTC

public static int xrCreateSpatialAnchorHTC(XrSession session,
 XrSpatialAnchorCreateInfoHTC createInfo,
 org.lwjgl.PointerBuffer anchor)

Creates a spatial anchor.

C Specification

The CreateSpatialAnchorHTC function is defined as:

 XrResult xrCreateSpatialAnchorHTC(
     XrSession                                   session,
     const XrSpatialAnchorCreateInfoHTC*         createInfo,
     XrSpace*                                    anchor);

Description

The CreateSpatialAnchorHTC function creates a spatial anchor with specified base space and pose in the space. The anchor is represented by an XrSpace and its pose can be tracked via LocateSpace. Once the anchor is no longer needed, call DestroySpace to erase the anchor.

Valid Usage (Implicit)

• The XR_HTC_anchor extension must be enabled prior to calling CreateSpatialAnchorHTC
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrSpatialAnchorCreateInfoHTC structure
• anchor must be a pointer to an XrSpace handle

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_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_POSE_INVALID
• ERROR_NAME_INVALID

See Also

XrSpatialAnchorCreateInfoHTC

Parameters:

session - the XrSession to create the anchor in.

createInfo - the XrSpatialAnchorCreateInfoHTC used to specify the anchor.

anchor - the returned XrSpace handle.

nxrGetSpatialAnchorNameHTC

public static int nxrGetSpatialAnchorNameHTC(XrSpace anchor,
 long name)

Unsafe version of: GetSpatialAnchorNameHTC

xrGetSpatialAnchorNameHTC

public static int xrGetSpatialAnchorNameHTC(XrSpace anchor,
 XrSpatialAnchorNameHTC name)

Get name of a spatial anchor.

C Specification

The GetSpatialAnchorNameHTC function is defined as:

 XrResult xrGetSpatialAnchorNameHTC(
     XrSpace                                     anchor,
     XrSpatialAnchorNameHTC*                     name);

Description

The GetSpatialAnchorNameHTC function gets the name of an anchor. If the provided anchor is a valid space handle but was not created with CreateSpatialAnchorHTC, the runtime must return ERROR_NOT_AN_ANCHOR_HTC.

Valid Usage (Implicit)

• The XR_HTC_anchor extension must be enabled prior to calling GetSpatialAnchorNameHTC
• anchor must be a valid XrSpace handle
• name must be a pointer to an XrSpatialAnchorNameHTC 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_NOT_AN_ANCHOR_HTC

See Also

XrSpatialAnchorNameHTC

Parameters:

anchor - the XrSpace created by CreateSpatialAnchorHTC.

name - a pointer to output XrSpatialAnchorNameHTC.