Package org.lwjgl.openxr

Class FBSpatialEntity

java.lang.Object

org.lwjgl.openxr.FBSpatialEntity

public class FBSpatialEntity
extends Object

The XR_FB_spatial_entity extension.

This extension enables applications to use spatial entities to specify world-locked frames of reference. It enables applications to persist the real world location of content over time and contains definitions for the Entity-Component System. All Facebook spatial entity and scene extensions are dependent on this one.

We use OpenXR XrSpace handles to give applications access to spatial entities such as Spatial Anchors. In other words, any operation which involves spatial entities uses XrSpace handles to identify the affected spatial entities.

In order to enable the functionality of this extension, you must pass the name of the extension into CreateInstance via the XrInstanceCreateInfo::enabledExtensionNames parameter as indicated in the extension section.

This extension allows:

• An application to create a Spatial Anchor (a type of spatial entity).
• An application to enumerate supported components for a given spatial entity.
• An application to enable or disable a component for a given spatial entity.
• An application to get the status of a component for a given spatial entity.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB	Extends XrResult.
static final int	XR_ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB	Extends XrResult.
static final int	XR_ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB	Extends XrResult.
static final int	XR_ERROR_SPACE_COMPONENT_STATUS_PENDING_FB	Extends XrResult.
static final String	XR_FB_SPATIAL_ENTITY_EXTENSION_NAME	The extension name.
static final int	XR_FB_spatial_entity_SPEC_VERSION	The extension specification version.
static final int	XR_SPACE_COMPONENT_TYPE_BOUNDED_2D_FB	XrSpaceComponentTypeFB - Component type
static final int	XR_SPACE_COMPONENT_TYPE_BOUNDED_3D_FB	XrSpaceComponentTypeFB - Component type
static final int	XR_SPACE_COMPONENT_TYPE_LOCATABLE_FB	XrSpaceComponentTypeFB - Component type
static final int	XR_SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB	XrSpaceComponentTypeFB - Component type
static final int	XR_SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB	XrSpaceComponentTypeFB - Component type
static final int	XR_SPACE_COMPONENT_TYPE_SHARABLE_FB	XrSpaceComponentTypeFB - Component type
static final int	XR_SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB	XrSpaceComponentTypeFB - Component type
static final int	XR_SPACE_COMPONENT_TYPE_STORABLE_FB	XrSpaceComponentTypeFB - Component type
static final int	XR_TYPE_EVENT_DATA_SPACE_SET_STATUS_COMPLETE_FB	Extends XrStructureType.
static final int	XR_TYPE_EVENT_DATA_SPATIAL_ANCHOR_CREATE_COMPLETE_FB	Extends XrStructureType.
static final int	XR_TYPE_SPACE_COMPONENT_STATUS_FB	Extends XrStructureType.
static final int	XR_TYPE_SPACE_COMPONENT_STATUS_SET_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateSpatialAnchorFB(XrSession session, long info, long requestId)	Unsafe version of: CreateSpatialAnchorFB
static int	nxrEnumerateSpaceSupportedComponentsFB(XrSpace space, int componentTypeCapacityInput, long componentTypeCountOutput, long componentTypes)	Unsafe version of: EnumerateSpaceSupportedComponentsFB
static int	nxrGetSpaceComponentStatusFB(XrSpace space, int componentType, long status)	Unsafe version of: GetSpaceComponentStatusFB
static int	nxrGetSpaceUuidFB(XrSpace space, long uuid)	Unsafe version of: GetSpaceUuidFB
static int	nxrSetSpaceComponentStatusFB(XrSpace space, long info, long requestId)	Unsafe version of: SetSpaceComponentStatusFB
static int	xrCreateSpatialAnchorFB(XrSession session, XrSpatialAnchorCreateInfoFB info, LongBuffer requestId)	Creates a new spatial anchor.
static int	xrEnumerateSpaceSupportedComponentsFB(XrSpace space, IntBuffer componentTypeCountOutput, @Nullable IntBuffer componentTypes)	Enumerates supported components for a given spatial entity.
static int	xrGetSpaceComponentStatusFB(XrSpace space, int componentType, XrSpaceComponentStatusFB status)	Provides the current state of a component.
static int	xrGetSpaceUuidFB(XrSpace space, XrUuidEXT uuid)	Gets an entity.
static int	xrSetSpaceComponentStatusFB(XrSpace space, XrSpaceComponentStatusSetInfoFB info, LongBuffer requestId)	Enables or disables supported component interfaces for an entity.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_spatial_entity_SPEC_VERSION

public static final int XR_FB_spatial_entity_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_SPATIAL_ENTITY_EXTENSION_NAME

public static final String XR_FB_SPATIAL_ENTITY_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB

public static final int XR_TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB
• TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_SET_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_FB
• TYPE_EVENT_DATA_SPATIAL_ANCHOR_CREATE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_SET_STATUS_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB

public static final int XR_TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB
• TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_SET_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_FB
• TYPE_EVENT_DATA_SPATIAL_ANCHOR_CREATE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_SET_STATUS_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_SPACE_COMPONENT_STATUS_SET_INFO_FB

public static final int XR_TYPE_SPACE_COMPONENT_STATUS_SET_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB
• TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_SET_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_FB
• TYPE_EVENT_DATA_SPATIAL_ANCHOR_CREATE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_SET_STATUS_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_SPACE_COMPONENT_STATUS_FB

public static final int XR_TYPE_SPACE_COMPONENT_STATUS_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB
• TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_SET_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_FB
• TYPE_EVENT_DATA_SPATIAL_ANCHOR_CREATE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_SET_STATUS_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_SPATIAL_ANCHOR_CREATE_COMPLETE_FB

public static final int XR_TYPE_EVENT_DATA_SPATIAL_ANCHOR_CREATE_COMPLETE_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB
• TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_SET_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_FB
• TYPE_EVENT_DATA_SPATIAL_ANCHOR_CREATE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_SET_STATUS_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_SPACE_SET_STATUS_COMPLETE_FB

public static final int XR_TYPE_EVENT_DATA_SPACE_SET_STATUS_COMPLETE_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB
• TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_SET_INFO_FB
• TYPE_SPACE_COMPONENT_STATUS_FB
• TYPE_EVENT_DATA_SPATIAL_ANCHOR_CREATE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_SET_STATUS_COMPLETE_FB

See Also:

• Constant Field Values

XR_ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB

public static final int XR_ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB

Extends XrResult.

Enum values:

• ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB
• ERROR_SPACE_COMPONENT_NOT_ENABLED_FB
• ERROR_SPACE_COMPONENT_STATUS_PENDING_FB
• ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB

See Also:

• Constant Field Values

XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB

public static final int XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB

Extends XrResult.

Enum values:

• ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB
• ERROR_SPACE_COMPONENT_NOT_ENABLED_FB
• ERROR_SPACE_COMPONENT_STATUS_PENDING_FB
• ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB

See Also:

• Constant Field Values

XR_ERROR_SPACE_COMPONENT_STATUS_PENDING_FB

public static final int XR_ERROR_SPACE_COMPONENT_STATUS_PENDING_FB

Extends XrResult.

Enum values:

• ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB
• ERROR_SPACE_COMPONENT_NOT_ENABLED_FB
• ERROR_SPACE_COMPONENT_STATUS_PENDING_FB
• ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB

See Also:

• Constant Field Values

XR_ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB

public static final int XR_ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB

Extends XrResult.

Enum values:

• ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB
• ERROR_SPACE_COMPONENT_NOT_ENABLED_FB
• ERROR_SPACE_COMPONENT_STATUS_PENDING_FB
• ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB

See Also:

• Constant Field Values

XR_SPACE_COMPONENT_TYPE_LOCATABLE_FB

public static final int XR_SPACE_COMPONENT_TYPE_LOCATABLE_FB

XrSpaceComponentTypeFB - Component type

Description

Specify the component interfaces attached to the spatial entity.

Enumerant Descriptions

• SPACE_COMPONENT_TYPE_LOCATABLE_FB — Enables tracking the 6 DOF pose of the XrSpace with LocateSpace.
• SPACE_COMPONENT_TYPE_STORABLE_FB — Enables persistence operations: save and erase.
• SPACE_COMPONENT_TYPE_SHARABLE_FB — Enables sharing of spatial entities.
• SPACE_COMPONENT_TYPE_BOUNDED_2D_FB — Bounded 2D component.
• SPACE_COMPONENT_TYPE_BOUNDED_3D_FB — Bounded 3D component.
• SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB — Semantic labels component.
• SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB — Room layout component.
• SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB — Space container component.

See Also

XrEventDataSpaceSetStatusCompleteFB, XrSpaceComponentFilterInfoFB, XrSpaceComponentStatusSetInfoFB, EnumerateSpaceSupportedComponentsFB, GetSpaceComponentStatusFB

See Also:

• Constant Field Values

XR_SPACE_COMPONENT_TYPE_STORABLE_FB

public static final int XR_SPACE_COMPONENT_TYPE_STORABLE_FB

XrSpaceComponentTypeFB - Component type

Description

Specify the component interfaces attached to the spatial entity.

Enumerant Descriptions

• SPACE_COMPONENT_TYPE_LOCATABLE_FB — Enables tracking the 6 DOF pose of the XrSpace with LocateSpace.
• SPACE_COMPONENT_TYPE_STORABLE_FB — Enables persistence operations: save and erase.
• SPACE_COMPONENT_TYPE_SHARABLE_FB — Enables sharing of spatial entities.
• SPACE_COMPONENT_TYPE_BOUNDED_2D_FB — Bounded 2D component.
• SPACE_COMPONENT_TYPE_BOUNDED_3D_FB — Bounded 3D component.
• SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB — Semantic labels component.
• SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB — Room layout component.
• SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB — Space container component.

See Also

XrEventDataSpaceSetStatusCompleteFB, XrSpaceComponentFilterInfoFB, XrSpaceComponentStatusSetInfoFB, EnumerateSpaceSupportedComponentsFB, GetSpaceComponentStatusFB

See Also:

• Constant Field Values

XR_SPACE_COMPONENT_TYPE_SHARABLE_FB

public static final int XR_SPACE_COMPONENT_TYPE_SHARABLE_FB

XrSpaceComponentTypeFB - Component type

Description

Specify the component interfaces attached to the spatial entity.

Enumerant Descriptions

• SPACE_COMPONENT_TYPE_LOCATABLE_FB — Enables tracking the 6 DOF pose of the XrSpace with LocateSpace.
• SPACE_COMPONENT_TYPE_STORABLE_FB — Enables persistence operations: save and erase.
• SPACE_COMPONENT_TYPE_SHARABLE_FB — Enables sharing of spatial entities.
• SPACE_COMPONENT_TYPE_BOUNDED_2D_FB — Bounded 2D component.
• SPACE_COMPONENT_TYPE_BOUNDED_3D_FB — Bounded 3D component.
• SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB — Semantic labels component.
• SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB — Room layout component.
• SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB — Space container component.

See Also

XrEventDataSpaceSetStatusCompleteFB, XrSpaceComponentFilterInfoFB, XrSpaceComponentStatusSetInfoFB, EnumerateSpaceSupportedComponentsFB, GetSpaceComponentStatusFB

See Also:

• Constant Field Values

XR_SPACE_COMPONENT_TYPE_BOUNDED_2D_FB

public static final int XR_SPACE_COMPONENT_TYPE_BOUNDED_2D_FB

XrSpaceComponentTypeFB - Component type

Description

Specify the component interfaces attached to the spatial entity.

Enumerant Descriptions

• SPACE_COMPONENT_TYPE_LOCATABLE_FB — Enables tracking the 6 DOF pose of the XrSpace with LocateSpace.
• SPACE_COMPONENT_TYPE_STORABLE_FB — Enables persistence operations: save and erase.
• SPACE_COMPONENT_TYPE_SHARABLE_FB — Enables sharing of spatial entities.
• SPACE_COMPONENT_TYPE_BOUNDED_2D_FB — Bounded 2D component.
• SPACE_COMPONENT_TYPE_BOUNDED_3D_FB — Bounded 3D component.
• SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB — Semantic labels component.
• SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB — Room layout component.
• SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB — Space container component.

See Also

XrEventDataSpaceSetStatusCompleteFB, XrSpaceComponentFilterInfoFB, XrSpaceComponentStatusSetInfoFB, EnumerateSpaceSupportedComponentsFB, GetSpaceComponentStatusFB

See Also:

• Constant Field Values

XR_SPACE_COMPONENT_TYPE_BOUNDED_3D_FB

public static final int XR_SPACE_COMPONENT_TYPE_BOUNDED_3D_FB

XrSpaceComponentTypeFB - Component type

Description

Specify the component interfaces attached to the spatial entity.

Enumerant Descriptions

• SPACE_COMPONENT_TYPE_LOCATABLE_FB — Enables tracking the 6 DOF pose of the XrSpace with LocateSpace.
• SPACE_COMPONENT_TYPE_STORABLE_FB — Enables persistence operations: save and erase.
• SPACE_COMPONENT_TYPE_SHARABLE_FB — Enables sharing of spatial entities.
• SPACE_COMPONENT_TYPE_BOUNDED_2D_FB — Bounded 2D component.
• SPACE_COMPONENT_TYPE_BOUNDED_3D_FB — Bounded 3D component.
• SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB — Semantic labels component.
• SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB — Room layout component.
• SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB — Space container component.

See Also

XrEventDataSpaceSetStatusCompleteFB, XrSpaceComponentFilterInfoFB, XrSpaceComponentStatusSetInfoFB, EnumerateSpaceSupportedComponentsFB, GetSpaceComponentStatusFB

See Also:

• Constant Field Values

XR_SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB

public static final int XR_SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB

XrSpaceComponentTypeFB - Component type

Description

Specify the component interfaces attached to the spatial entity.

Enumerant Descriptions

• SPACE_COMPONENT_TYPE_LOCATABLE_FB — Enables tracking the 6 DOF pose of the XrSpace with LocateSpace.
• SPACE_COMPONENT_TYPE_STORABLE_FB — Enables persistence operations: save and erase.
• SPACE_COMPONENT_TYPE_SHARABLE_FB — Enables sharing of spatial entities.
• SPACE_COMPONENT_TYPE_BOUNDED_2D_FB — Bounded 2D component.
• SPACE_COMPONENT_TYPE_BOUNDED_3D_FB — Bounded 3D component.
• SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB — Semantic labels component.
• SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB — Room layout component.
• SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB — Space container component.

See Also

XrEventDataSpaceSetStatusCompleteFB, XrSpaceComponentFilterInfoFB, XrSpaceComponentStatusSetInfoFB, EnumerateSpaceSupportedComponentsFB, GetSpaceComponentStatusFB

See Also:

• Constant Field Values

XR_SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB

public static final int XR_SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB

XrSpaceComponentTypeFB - Component type

Description

Specify the component interfaces attached to the spatial entity.

Enumerant Descriptions

• SPACE_COMPONENT_TYPE_LOCATABLE_FB — Enables tracking the 6 DOF pose of the XrSpace with LocateSpace.
• SPACE_COMPONENT_TYPE_STORABLE_FB — Enables persistence operations: save and erase.
• SPACE_COMPONENT_TYPE_SHARABLE_FB — Enables sharing of spatial entities.
• SPACE_COMPONENT_TYPE_BOUNDED_2D_FB — Bounded 2D component.
• SPACE_COMPONENT_TYPE_BOUNDED_3D_FB — Bounded 3D component.
• SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB — Semantic labels component.
• SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB — Room layout component.
• SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB — Space container component.

See Also

XrEventDataSpaceSetStatusCompleteFB, XrSpaceComponentFilterInfoFB, XrSpaceComponentStatusSetInfoFB, EnumerateSpaceSupportedComponentsFB, GetSpaceComponentStatusFB

See Also:

• Constant Field Values

XR_SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB

public static final int XR_SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB

XrSpaceComponentTypeFB - Component type

Description

Specify the component interfaces attached to the spatial entity.

Enumerant Descriptions

• SPACE_COMPONENT_TYPE_LOCATABLE_FB — Enables tracking the 6 DOF pose of the XrSpace with LocateSpace.
• SPACE_COMPONENT_TYPE_STORABLE_FB — Enables persistence operations: save and erase.
• SPACE_COMPONENT_TYPE_SHARABLE_FB — Enables sharing of spatial entities.
• SPACE_COMPONENT_TYPE_BOUNDED_2D_FB — Bounded 2D component.
• SPACE_COMPONENT_TYPE_BOUNDED_3D_FB — Bounded 3D component.
• SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB — Semantic labels component.
• SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB — Room layout component.
• SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB — Space container component.

See Also

XrEventDataSpaceSetStatusCompleteFB, XrSpaceComponentFilterInfoFB, XrSpaceComponentStatusSetInfoFB, EnumerateSpaceSupportedComponentsFB, GetSpaceComponentStatusFB

See Also:

• Constant Field Values

Method Details

nxrCreateSpatialAnchorFB

public static int nxrCreateSpatialAnchorFB(XrSession session,
 long info,
 long requestId)

Unsafe version of: CreateSpatialAnchorFB

xrCreateSpatialAnchorFB

public static int xrCreateSpatialAnchorFB(XrSession session,
 XrSpatialAnchorCreateInfoFB info,
 LongBuffer requestId)

Creates a new spatial anchor.

C Specification

The CreateSpatialAnchorFB function is defined as:

 XrResult xrCreateSpatialAnchorFB(
     XrSession                                   session,
     const XrSpatialAnchorCreateInfoFB*          info,
     XrAsyncRequestIdFB*                         requestId);

Description

Creates a Spatial Anchor using the specified tracking origin and pose relative to the specified tracking origin. The anchor will be locatable at the time of creation, and the 6 DOF pose relative to the tracking origin can be queried using the LocateSpace method. This operation is asynchronous and the runtime must post an XrEventDataSpatialAnchorCreateCompleteFB event when the operation completes successfully or encounters an error. If this function returns a failure code, no event is posted. The requestId can be used to later refer to the request, such as identifying which request has completed when an XrEventDataSpatialAnchorCreateCompleteFB is posted to the event queue.

Valid Usage (Implicit)

• The XR_FB_spatial_entity extension must be enabled prior to calling CreateSpatialAnchorFB
• session must be a valid XrSession handle
• info must be a pointer to a valid XrSpatialAnchorCreateInfoFB structure
• requestId must be a pointer to an XrAsyncRequestIdFB value

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_TIME_INVALID
• ERROR_POSE_INVALID
• ERROR_FEATURE_UNSUPPORTED

See Also

XrSpatialAnchorCreateInfoFB

Parameters:

session - a handle to an XrSession.

info - a pointer to an XrSpatialAnchorCreateInfoFB structure containing information about how to create the anchor.

requestId - the output parameter that points to the ID of this asynchronous request.

nxrGetSpaceUuidFB

public static int nxrGetSpaceUuidFB(XrSpace space,
 long uuid)

Unsafe version of: GetSpaceUuidFB

xrGetSpaceUuidFB

public static int xrGetSpaceUuidFB(XrSpace space,
 XrUuidEXT uuid)

Gets an entity.

C Specification

The GetSpaceUuidFB function is defined as:

 XrResult xrGetSpaceUuidFB(
     XrSpace                                     space,
     XrUuidEXT*                                  uuid);

Description

Gets the UUID for a spatial entity. If this space was previously created as a spatial anchor, uuid must be equal to the XrEventDataSpatialAnchorCreateCompleteFB::uuid in the event corresponding to the creation of that space. Subsequent calls to GetSpaceUuidFB using the same XrSpace must return the same XrUuidEXT.

Valid Usage (Implicit)

• The XR_FB_spatial_entity extension must be enabled prior to calling GetSpaceUuidFB
• space must be a valid XrSpace handle
• uuid must be a pointer to an XrUuidEXT 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_FEATURE_UNSUPPORTED

See Also

XrUuidEXT

Parameters:

space - the XrSpace handle of a spatial entity.

uuid - an output parameter pointing to the entity’s UUID.

nxrEnumerateSpaceSupportedComponentsFB

public static int nxrEnumerateSpaceSupportedComponentsFB(XrSpace space,
 int componentTypeCapacityInput,
 long componentTypeCountOutput,
 long componentTypes)

Unsafe version of: EnumerateSpaceSupportedComponentsFB

Parameters:

componentTypeCapacityInput - the capacity of the componentTypes array, or 0 to indicate a request to retrieve the required capacity.

xrEnumerateSpaceSupportedComponentsFB

public static int xrEnumerateSpaceSupportedComponentsFB(XrSpace space,
 IntBuffer componentTypeCountOutput,
 @Nullable IntBuffer componentTypes)

Enumerates supported components for a given spatial entity.

C Specification

The EnumerateSpaceSupportedComponentsFB function is defined as:

 XrResult xrEnumerateSpaceSupportedComponentsFB(
     XrSpace                                     space,
     uint32_t                                    componentTypeCapacityInput,
     uint32_t*                                   componentTypeCountOutput,
     XrSpaceComponentTypeFB*                     componentTypes);

Description

Lists any component types that an entity supports. The list of component types available for an entity depends on which extensions are enabled. Component types must not be enumerated unless the corresponding extension that defines them is also enabled.

Valid Usage (Implicit)

• The XR_FB_spatial_entity extension must be enabled prior to calling EnumerateSpaceSupportedComponentsFB
• space must be a valid XrSpace handle
• componentTypeCountOutput must be a pointer to a uint32_t value
• If componentTypeCapacityInput is not 0, componentTypes must be a pointer to an array of componentTypeCapacityInput XrSpaceComponentTypeFB values

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_FEATURE_UNSUPPORTED

Parameters:

space - the XrSpace handle to the spatial entity.

componentTypeCountOutput - a pointer to the count of componentTypes written, or a pointer to the required capacity in the case that componentTypeCapacityInput is insufficient.

componentTypes - a pointer to an array of XrSpaceComponentTypeFB values, but can be NULL if componentTypeCapacityInput is 0.

nxrSetSpaceComponentStatusFB

public static int nxrSetSpaceComponentStatusFB(XrSpace space,
 long info,
 long requestId)

Unsafe version of: SetSpaceComponentStatusFB

xrSetSpaceComponentStatusFB

public static int xrSetSpaceComponentStatusFB(XrSpace space,
 XrSpaceComponentStatusSetInfoFB info,
 LongBuffer requestId)

Enables or disables supported component interfaces for an entity.

C Specification

The SetSpaceComponentStatusFB function is defined as:

 XrResult xrSetSpaceComponentStatusFB(
     XrSpace                                     space,
     const XrSpaceComponentStatusSetInfoFB*      info,
     XrAsyncRequestIdFB*                         requestId);

Description

Enables or disables the specified component for the specified entity. This operation is asynchronous and always returns immediately, regardless of the value of XrSpaceComponentStatusSetInfoFB::timeout. The requestId can be used to later refer to the request, such as identifying which request has completed when an XrEventDataSpaceSetStatusCompleteFB is posted to the event queue. If this function returns a failure code, no event is posted. This function must return ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB if the XrSpace does not support the specified component type.

Valid Usage (Implicit)

• The XR_FB_spatial_entity extension must be enabled prior to calling SetSpaceComponentStatusFB
• space must be a valid XrSpace handle
• info must be a pointer to a valid XrSpaceComponentStatusSetInfoFB structure
• requestId must be a pointer to an XrAsyncRequestIdFB value

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_SPACE_COMPONENT_STATUS_PENDING_FB
• ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB
• ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrSpaceComponentStatusSetInfoFB

Parameters:

space - the XrSpace handle to the spatial entity.

info - a pointer to an XrSpaceComponentStatusSetInfoFB structure containing information about the component to be enabled or disabled.

requestId - the output parameter that points to the ID of this asynchronous request.

nxrGetSpaceComponentStatusFB

public static int nxrGetSpaceComponentStatusFB(XrSpace space,
 int componentType,
 long status)

Unsafe version of: GetSpaceComponentStatusFB

xrGetSpaceComponentStatusFB

public static int xrGetSpaceComponentStatusFB(XrSpace space,
 int componentType,
 XrSpaceComponentStatusFB status)

Provides the current state of a component.

C Specification

The GetSpaceComponentStatusFB function is defined as:

 XrResult xrGetSpaceComponentStatusFB(
     XrSpace                                     space,
     XrSpaceComponentTypeFB                      componentType,
     XrSpaceComponentStatusFB*                   status);

Description

Gets the current status of the specified component for the specified entity. This function must return ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB if the XrSpace does not support the specified component type.

Valid Usage (Implicit)

• The XR_FB_spatial_entity extension must be enabled prior to calling GetSpaceComponentStatusFB
• space must be a valid XrSpace handle
• componentType must be a valid XrSpaceComponentTypeFB value
• status must be a pointer to an XrSpaceComponentStatusFB 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_SPACE_COMPONENT_NOT_SUPPORTED_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrSpaceComponentStatusFB

Parameters:

space - the XrSpace handle of a spatial entity.

componentType - the component type to query.

status - an output parameter pointing to the structure containing the status of the component that was queried.