Package org.lwjgl.openxr

Class FBSpatialEntityStorageBatch

java.lang.Object

org.lwjgl.openxr.FBSpatialEntityStorageBatch

public class FBSpatialEntityStorageBatch
extends Object

The XR_FB_spatial_entity_storage_batch extension.

This extension enables multiple spatial entities at a time to be persisted across sessions. If the SPACE_COMPONENT_TYPE_STORABLE_FB component has been enabled on the spatial entity, application developers may save and erase XrSpace 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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_FB_SPATIAL_ENTITY_STORAGE_BATCH_EXTENSION_NAME	The extension name.
static final int	XR_FB_spatial_entity_storage_batch_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_EVENT_DATA_SPACE_LIST_SAVE_COMPLETE_FB	Extends XrStructureType.
static final int	XR_TYPE_SPACE_LIST_SAVE_INFO_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrSaveSpaceListFB(XrSession session, long info, long requestId)	Unsafe version of: SaveSpaceListFB
static int	xrSaveSpaceListFB(XrSession session, XrSpaceListSaveInfoFB info, LongBuffer requestId)	Saves a list of spatial entities to persistent storage.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_spatial_entity_storage_batch_SPEC_VERSION

public static final int XR_FB_spatial_entity_storage_batch_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_SPATIAL_ENTITY_STORAGE_BATCH_EXTENSION_NAME

public static final String XR_FB_SPATIAL_ENTITY_STORAGE_BATCH_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SPACE_LIST_SAVE_INFO_FB

public static final int XR_TYPE_SPACE_LIST_SAVE_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_LIST_SAVE_INFO_FB
• TYPE_EVENT_DATA_SPACE_LIST_SAVE_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_SPACE_LIST_SAVE_COMPLETE_FB

public static final int XR_TYPE_EVENT_DATA_SPACE_LIST_SAVE_COMPLETE_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_LIST_SAVE_INFO_FB
• TYPE_EVENT_DATA_SPACE_LIST_SAVE_COMPLETE_FB

See Also:

• Constant Field Values

Method Details

nxrSaveSpaceListFB

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

Unsafe version of: SaveSpaceListFB

xrSaveSpaceListFB

public static int xrSaveSpaceListFB(XrSession session,
 XrSpaceListSaveInfoFB info,
 LongBuffer requestId)

Saves a list of spatial entities to persistent storage.

C Specification

The SaveSpaceListFB function is defined as:

 XrResult xrSaveSpaceListFB(
     XrSession                                   session,
     const XrSpaceListSaveInfoFB*                info,
     XrAsyncRequestIdFB*                         requestId);

Description

The SaveSpaceListFB function persists the specified spatial entities at the specified storage location. The runtime must return ERROR_VALIDATION_FAILURE if XrSpaceSaveInfoFB::location is invalid. This operation is asynchronous and the runtime must post an XrEventDataSpaceListSaveCompleteFB event when the operation completes successfully or encounters an error. If this function returns a failure code, no event is posted.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_storage_batch extension must be enabled prior to calling SaveSpaceListFB
• session must be a valid XrSession handle
• info must be a pointer to a valid XrSpaceListSaveInfoFB 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_NETWORK_TIMEOUT_FB
• ERROR_SPACE_NETWORK_REQUEST_FAILED_FB
• ERROR_SPACE_MAPPING_INSUFFICIENT_FB
• ERROR_SPACE_LOCALIZATION_FAILED_FB
• ERROR_SPACE_COMPONENT_NOT_ENABLED_FB
• ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrSpaceListSaveInfoFB

Parameters:

session - a handle to an XrSession.

info - contains the parameters for the save operation.

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