Package org.lwjgl.openxr

Class FBSpatialEntityQuery

java.lang.Object

org.lwjgl.openxr.FBSpatialEntityQuery

public class FBSpatialEntityQuery
extends Object

The XR_FB_spatial_entity_query extension.

This extension enables an application to discover persistent spatial entities in the area and restore them. Using the query system, the application can load persistent spatial entities from storage. The query system consists of a set of filters to define the spatial entity search query and an operation that needs to be performed on the search results.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_FB_SPATIAL_ENTITY_QUERY_EXTENSION_NAME	The extension name.
static final int	XR_FB_spatial_entity_query_SPEC_VERSION	The extension specification version.
static final int	XR_SPACE_QUERY_ACTION_LOAD_FB	XrSpaceQueryActionFB - Type of query being performed
static final int	XR_SPACE_STORAGE_LOCATION_CLOUD_FB	XrSpaceStorageLocationFB - Storage location to persist spatial entities
static final int	XR_SPACE_STORAGE_LOCATION_INVALID_FB	XrSpaceStorageLocationFB - Storage location to persist spatial entities
static final int	XR_SPACE_STORAGE_LOCATION_LOCAL_FB	XrSpaceStorageLocationFB - Storage location to persist spatial entities
static final int	XR_TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB	Extends XrStructureType.
static final int	XR_TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB	Extends XrStructureType.
static final int	XR_TYPE_SPACE_COMPONENT_FILTER_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_SPACE_QUERY_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_SPACE_QUERY_RESULTS_FB	Extends XrStructureType.
static final int	XR_TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_SPACE_UUID_FILTER_INFO_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrQuerySpacesFB(XrSession session, long info, long requestId)	Unsafe version of: QuerySpacesFB
static int	nxrRetrieveSpaceQueryResultsFB(XrSession session, long requestId, long results)	Unsafe version of: RetrieveSpaceQueryResultsFB
static int	xrQuerySpacesFB(XrSession session, XrSpaceQueryInfoBaseHeaderFB info, LongBuffer requestId)	Queries for spatial entities.
static int	xrRetrieveSpaceQueryResultsFB(XrSession session, long requestId, XrSpaceQueryResultsFB results)	Copies query results into an output buffer.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_spatial_entity_query_SPEC_VERSION

public static final int XR_FB_spatial_entity_query_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_SPATIAL_ENTITY_QUERY_EXTENSION_NAME

public static final String XR_FB_SPATIAL_ENTITY_QUERY_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SPACE_QUERY_INFO_FB

public static final int XR_TYPE_SPACE_QUERY_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_QUERY_INFO_FB
• TYPE_SPACE_QUERY_RESULTS_FB
• TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB
• TYPE_SPACE_UUID_FILTER_INFO_FB
• TYPE_SPACE_COMPONENT_FILTER_INFO_FB
• TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB
• TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_SPACE_QUERY_RESULTS_FB

public static final int XR_TYPE_SPACE_QUERY_RESULTS_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_QUERY_INFO_FB
• TYPE_SPACE_QUERY_RESULTS_FB
• TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB
• TYPE_SPACE_UUID_FILTER_INFO_FB
• TYPE_SPACE_COMPONENT_FILTER_INFO_FB
• TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB
• TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB

public static final int XR_TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_QUERY_INFO_FB
• TYPE_SPACE_QUERY_RESULTS_FB
• TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB
• TYPE_SPACE_UUID_FILTER_INFO_FB
• TYPE_SPACE_COMPONENT_FILTER_INFO_FB
• TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB
• TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_SPACE_UUID_FILTER_INFO_FB

public static final int XR_TYPE_SPACE_UUID_FILTER_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_QUERY_INFO_FB
• TYPE_SPACE_QUERY_RESULTS_FB
• TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB
• TYPE_SPACE_UUID_FILTER_INFO_FB
• TYPE_SPACE_COMPONENT_FILTER_INFO_FB
• TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB
• TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_SPACE_COMPONENT_FILTER_INFO_FB

public static final int XR_TYPE_SPACE_COMPONENT_FILTER_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_QUERY_INFO_FB
• TYPE_SPACE_QUERY_RESULTS_FB
• TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB
• TYPE_SPACE_UUID_FILTER_INFO_FB
• TYPE_SPACE_COMPONENT_FILTER_INFO_FB
• TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB
• TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB

public static final int XR_TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_QUERY_INFO_FB
• TYPE_SPACE_QUERY_RESULTS_FB
• TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB
• TYPE_SPACE_UUID_FILTER_INFO_FB
• TYPE_SPACE_COMPONENT_FILTER_INFO_FB
• TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB
• TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

public static final int XR_TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_QUERY_INFO_FB
• TYPE_SPACE_QUERY_RESULTS_FB
• TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB
• TYPE_SPACE_UUID_FILTER_INFO_FB
• TYPE_SPACE_COMPONENT_FILTER_INFO_FB
• TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB
• TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

See Also:

• Constant Field Values

XR_SPACE_QUERY_ACTION_LOAD_FB

public static final int XR_SPACE_QUERY_ACTION_LOAD_FB

XrSpaceQueryActionFB - Type of query being performed

Description

Specify the type of query being performed.

Enumerant Descriptions

• SPACE_QUERY_ACTION_LOAD_FB — Tells the query to perform a load operation on any XrSpace returned by the query.

See Also

XrSpaceQueryInfoFB

See Also:

• Constant Field Values

XR_SPACE_STORAGE_LOCATION_INVALID_FB

public static final int XR_SPACE_STORAGE_LOCATION_INVALID_FB

XrSpaceStorageLocationFB - Storage location to persist spatial entities

Description

The XrSpaceStorageLocationFB enumeration contains the storage locations used to store, erase, and query spatial entities.

Enumerant Descriptions

• SPACE_STORAGE_LOCATION_INVALID_FB — Invalid storage location
• SPACE_STORAGE_LOCATION_LOCAL_FB — Local device storage
• SPACE_STORAGE_LOCATION_CLOUD_FB — Cloud storage

See Also

XrEventDataSpaceEraseCompleteFB, XrEventDataSpaceSaveCompleteFB, XrSpaceEraseInfoFB, XrSpaceListSaveInfoFB, XrSpaceSaveInfoFB, XrSpaceStorageLocationFilterInfoFB

See Also:

• Constant Field Values

XR_SPACE_STORAGE_LOCATION_LOCAL_FB

public static final int XR_SPACE_STORAGE_LOCATION_LOCAL_FB

XrSpaceStorageLocationFB - Storage location to persist spatial entities

Description

The XrSpaceStorageLocationFB enumeration contains the storage locations used to store, erase, and query spatial entities.

Enumerant Descriptions

• SPACE_STORAGE_LOCATION_INVALID_FB — Invalid storage location
• SPACE_STORAGE_LOCATION_LOCAL_FB — Local device storage
• SPACE_STORAGE_LOCATION_CLOUD_FB — Cloud storage

See Also

XrEventDataSpaceEraseCompleteFB, XrEventDataSpaceSaveCompleteFB, XrSpaceEraseInfoFB, XrSpaceListSaveInfoFB, XrSpaceSaveInfoFB, XrSpaceStorageLocationFilterInfoFB

See Also:

• Constant Field Values

XR_SPACE_STORAGE_LOCATION_CLOUD_FB

public static final int XR_SPACE_STORAGE_LOCATION_CLOUD_FB

XrSpaceStorageLocationFB - Storage location to persist spatial entities

Description

The XrSpaceStorageLocationFB enumeration contains the storage locations used to store, erase, and query spatial entities.

Enumerant Descriptions

• SPACE_STORAGE_LOCATION_INVALID_FB — Invalid storage location
• SPACE_STORAGE_LOCATION_LOCAL_FB — Local device storage
• SPACE_STORAGE_LOCATION_CLOUD_FB — Cloud storage

See Also

XrEventDataSpaceEraseCompleteFB, XrEventDataSpaceSaveCompleteFB, XrSpaceEraseInfoFB, XrSpaceListSaveInfoFB, XrSpaceSaveInfoFB, XrSpaceStorageLocationFilterInfoFB

See Also:

• Constant Field Values

Method Details

nxrQuerySpacesFB

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

Unsafe version of: QuerySpacesFB

xrQuerySpacesFB

public static int xrQuerySpacesFB(XrSession session,
 XrSpaceQueryInfoBaseHeaderFB info,
 LongBuffer requestId)

Queries for spatial entities.

C Specification

The QuerySpacesFB function is defined as:

 XrResult xrQuerySpacesFB(
     XrSession                                   session,
     const XrSpaceQueryInfoBaseHeaderFB*         info,
     XrAsyncRequestIdFB*                         requestId);

Description

The QuerySpacesFB function enables an application to find and retrieve spatial entities from storage. Cast an XrSpaceQueryInfoFB pointer to a XrSpaceQueryInfoBaseHeaderFB pointer to pass as info. The application should keep the returned requestId for the duration of the request as it is used to refer to the request when calling RetrieveSpaceQueryResultsFB and is used to map completion events to the request. This operation is asynchronous and the runtime must post an XrEventDataSpaceQueryCompleteFB event when the operation completes successfully or encounters an error. If this function returns a failure code, no event is posted. The runtime must post an XrEventDataSpaceQueryResultsAvailableFB before XrEventDataSpaceQueryCompleteFB if any results are found. Once an XrEventDataSpaceQueryResultsAvailableFB event has been posted, the application may call RetrieveSpaceQueryResultsFB to retrieve the available results.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_query extension must be enabled prior to calling QuerySpacesFB
• session must be a valid XrSession handle
• info must be a pointer to a valid XrSpaceQueryInfoBaseHeaderFB-based structure. See also: XrSpaceQueryInfoFB
• 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_FEATURE_UNSUPPORTED

See Also

XrSpaceQueryInfoBaseHeaderFB

Parameters:

session - a handle to an XrSession.

info - a pointer to the XrSpaceQueryInfoBaseHeaderFB structure.

requestId - an output parameter, and the variable it points to will be populated with the ID of this asynchronous request.

nxrRetrieveSpaceQueryResultsFB

public static int nxrRetrieveSpaceQueryResultsFB(XrSession session,
 long requestId,
 long results)

Unsafe version of: RetrieveSpaceQueryResultsFB

xrRetrieveSpaceQueryResultsFB

public static int xrRetrieveSpaceQueryResultsFB(XrSession session,
 long requestId,
 XrSpaceQueryResultsFB results)

Copies query results into an output buffer.

C Specification

The RetrieveSpaceQueryResultsFB function is defined as:

 XrResult xrRetrieveSpaceQueryResultsFB(
     XrSession                                   session,
     XrAsyncRequestIdFB                          requestId,
     XrSpaceQueryResultsFB*                      results);

Description

Allows an application to retrieve all available results for a specified query. Call this function once to get the number of results found and then once more to copy the results into a buffer provided by the application. The number of results will not change between the two calls used to retrieve results. This function must only retrieve each query result once. After the application has used this function to retrieve a query result, the runtime frees its copy. The runtime must return ERROR_VALIDATION_FAILURE if requestId refers to a request that is not yet complete, a request for which results have already been retrieved, or if requestId does not refer to a known request.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_query extension must be enabled prior to calling RetrieveSpaceQueryResultsFB
• session must be a valid XrSession handle
• results must be a pointer to an XrSpaceQueryResultsFB 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_FEATURE_UNSUPPORTED

See Also

XrSpaceQueryResultsFB

Parameters:

session - the XrSession for which the in-progress query is valid.

requestId - the XrAsyncRequestIdFB to enumerate results for.

results - a pointer to an XrSpaceQueryResultsFB to populate with results.