Top Description Fields Constructors Methods
org.lwjgl.openxr

public Class FBSpatialEntityQuery

extends Object
Class Inheritance
Imports
java.nio.*, org.lwjgl.system.*
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 extensions section.

Field Summary

Modifier and TypeField and Description
public static final String
XR_FB_SPATIAL_ENTITY_QUERY_EXTENSION_NAME

The extension name.

public static final int
XR_FB_spatial_entity_query_SPEC_VERSION

The extension specification version.

public static final int
XR_SPACE_QUERY_ACTION_LOAD_FB

XrSpaceQueryActionFB - Type of query being performed Description

Specify the type of query being performed.

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.

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.

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.

public static final int
XR_TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

Extends XrStructureType.

public static final int
XR_TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB

Extends XrStructureType.

public static final int
XR_TYPE_SPACE_COMPONENT_FILTER_INFO_FB

Extends XrStructureType.

public static final int
XR_TYPE_SPACE_QUERY_INFO_FB

Extends XrStructureType.

public static final int
XR_TYPE_SPACE_QUERY_RESULTS_FB

Extends XrStructureType.

public static final int
XR_TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB

Extends XrStructureType.

public static final int
XR_TYPE_SPACE_UUID_FILTER_INFO_FB

Extends XrStructureType.

Constructor Summary

AccessConstructor and Description
protected
FBSpatialEntityQuery()

Method Summary

Modifier and TypeMethod and Description
public static int
nxrQuerySpacesFB(XrSession session, long info, long requestId)

Unsafe version of: QuerySpacesFB

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

Unsafe version of: RetrieveSpaceQueryResultsFB

public static int
xrQuerySpacesFB(XrSession
a handle to an XrSession.
session, XrSpaceQueryInfoBaseHeaderFB
a pointer to the XrSpaceQueryInfoBaseHeaderFB structure.
info, LongBuffer
an output parameter, and the variable it points to will be populated with the ID of this asynchronous request.
requestId)

Queries for spatial entities.

public static int
xrRetrieveSpaceQueryResultsFB(XrSession
the XrSession for which the in-progress query is valid.
session, long
the XrAsyncRequestIdFB to enumerate results for.
requestId, XrSpaceQueryResultsFB
a pointer to an XrSpaceQueryResultsFB to populate with results.
results)

Copies query results into an output buffer.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

XR_FB_SPATIAL_ENTITY_QUERY_EXTENSION_NAMEback to summary
public static final String XR_FB_SPATIAL_ENTITY_QUERY_EXTENSION_NAME

The extension name.

XR_FB_spatial_entity_query_SPEC_VERSIONback to summary
public static final int XR_FB_spatial_entity_query_SPEC_VERSION

The extension specification version.

XR_SPACE_QUERY_ACTION_LOAD_FBback to summary
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
See Also

XrSpaceQueryInfoFB

XR_SPACE_STORAGE_LOCATION_CLOUD_FBback to summary
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
See Also

XrEventDataSpaceEraseCompleteFB, XrEventDataSpaceSaveCompleteFB, XrSpaceEraseInfoFB, XrSpaceListSaveInfoFB, XrSpaceSaveInfoFB, XrSpaceStorageLocationFilterInfoFB

XR_SPACE_STORAGE_LOCATION_INVALID_FBback to summary
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
See Also

XrEventDataSpaceEraseCompleteFB, XrEventDataSpaceSaveCompleteFB, XrSpaceEraseInfoFB, XrSpaceListSaveInfoFB, XrSpaceSaveInfoFB, XrSpaceStorageLocationFilterInfoFB

XR_SPACE_STORAGE_LOCATION_LOCAL_FBback to summary
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
See Also

XrEventDataSpaceEraseCompleteFB, XrEventDataSpaceSaveCompleteFB, XrSpaceEraseInfoFB, XrSpaceListSaveInfoFB, XrSpaceSaveInfoFB, XrSpaceStorageLocationFilterInfoFB

XR_TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FBback to summary
public static final int XR_TYPE_EVENT_DATA_SPACE_QUERY_COMPLETE_FB

Extends XrStructureType.

Enum values:
XR_TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FBback to summary
public static final int XR_TYPE_EVENT_DATA_SPACE_QUERY_RESULTS_AVAILABLE_FB

Extends XrStructureType.

Enum values:
XR_TYPE_SPACE_COMPONENT_FILTER_INFO_FBback to summary
public static final int XR_TYPE_SPACE_COMPONENT_FILTER_INFO_FB

Extends XrStructureType.

Enum values:
XR_TYPE_SPACE_QUERY_INFO_FBback to summary
public static final int XR_TYPE_SPACE_QUERY_INFO_FB

Extends XrStructureType.

Enum values:
XR_TYPE_SPACE_QUERY_RESULTS_FBback to summary
public static final int XR_TYPE_SPACE_QUERY_RESULTS_FB

Extends XrStructureType.

Enum values:
XR_TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FBback to summary
public static final int XR_TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB

Extends XrStructureType.

Enum values:
XR_TYPE_SPACE_UUID_FILTER_INFO_FBback to summary
public static final int XR_TYPE_SPACE_UUID_FILTER_INFO_FB

Extends XrStructureType.

Enum values:

Constructor Detail

FBSpatialEntityQueryback to summary
protected FBSpatialEntityQuery()

Method Detail

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

Unsafe version of: QuerySpacesFB

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

Unsafe version of: RetrieveSpaceQueryResultsFB

xrQuerySpacesFBback to summary
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)
Return Codes
On success, this command returns
On failure, this command returns
See Also

XrSpaceQueryInfoBaseHeaderFB

Parameters
session:XrSession

a handle to an XrSession.

info:XrSpaceQueryInfoBaseHeaderFB

a pointer to the XrSpaceQueryInfoBaseHeaderFB structure.

requestId:LongBuffer

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

Annotations
@NativeType:XrResult
xrRetrieveSpaceQueryResultsFBback to summary
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)
Return Codes
On success, this command returns
On failure, this command returns
See Also

XrSpaceQueryResultsFB

Parameters
session:XrSession

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

requestId:long

the XrAsyncRequestIdFB to enumerate results for.

results:XrSpaceQueryResultsFB

a pointer to an XrSpaceQueryResultsFB to populate with results.

Annotations
@NativeType:XrResult