public Class FBSpatialEntityStorage

The extension name.

The extension specification version.

XrSpacePersistenceModeFB - Persistence mode

Description

The XrSpacePersistenceModeFB enumeration specifies the persistence mode for the save operation.

Enumerant Descriptions

• SPACE_PERSISTENCE_MODE_INVALID_FB — Invalid storage persistence
• SPACE_PERSISTENCE_MODE_INDEFINITE_FB — Store XrSpace indefinitely, or until erased

See Also

XrSpaceSaveInfoFB

XrSpacePersistenceModeFB - Persistence mode

Description

The XrSpacePersistenceModeFB enumeration specifies the persistence mode for the save operation.

Enumerant Descriptions

• SPACE_PERSISTENCE_MODE_INVALID_FB — Invalid storage persistence
• SPACE_PERSISTENCE_MODE_INDEFINITE_FB — Store XrSpace indefinitely, or until erased

See Also

XrSpaceSaveInfoFB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_SAVE_INFO_FB
• TYPE_SPACE_ERASE_INFO_FB
• TYPE_EVENT_DATA_SPACE_SAVE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_ERASE_COMPLETE_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_SAVE_INFO_FB
• TYPE_SPACE_ERASE_INFO_FB
• TYPE_EVENT_DATA_SPACE_SAVE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_ERASE_COMPLETE_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_SAVE_INFO_FB
• TYPE_SPACE_ERASE_INFO_FB
• TYPE_EVENT_DATA_SPACE_SAVE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_ERASE_COMPLETE_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_SAVE_INFO_FB
• TYPE_SPACE_ERASE_INFO_FB
• TYPE_EVENT_DATA_SPACE_SAVE_COMPLETE_FB
• TYPE_EVENT_DATA_SPACE_ERASE_COMPLETE_FB

Unsafe version of: EraseSpaceFB

Unsafe version of: SaveSpaceFB

Erases a spatial entity from persistent storage.

C Specification

The EraseSpaceFB function is defined as:

XrResult xrEraseSpaceFB(
    XrSession                                   session,
    const XrSpaceEraseInfoFB*                   info,
    XrAsyncRequestIdFB*                         requestId);

Description

The EraseSpaceFB function erases a spatial entity from storage at the specified location. The XrSpace remains valid in the current session until the application destroys it or the session ends. The runtime must return ERROR_VALIDATION_FAILURE if XrSpaceEraseInfoFB::space is NULL_HANDLE or otherwise invalid. The runtime must return ERROR_VALIDATION_FAILURE if XrSpaceEraseInfoFB::location is invalid. This operation is asynchronous and the runtime must post an XrEventDataSpaceEraseCompleteFB 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 extension must be enabled prior to calling EraseSpaceFB
• session must be a valid XrSession handle
• info must be a pointer to a valid XrSpaceEraseInfoFB 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_NOT_ENABLED_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrSpaceEraseInfoFB, SaveSpaceFB

Parameters

session:XrSession

a handle to an XrSession.

info:XrSpaceEraseInfoFB

contains the parameters for the erase operation.

requestId:LongBuffer

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

Annotations

@NativeType:XrResult

Saves a spatial entity to persistent storage.

C Specification

The SaveSpaceFB function is defined as:

XrResult xrSaveSpaceFB(
    XrSession                                   session,
    const XrSpaceSaveInfoFB*                    info,
    XrAsyncRequestIdFB*                         requestId);

Description

The SaveSpaceFB function persists the spatial entity at the specified location with the specified mode. The runtime must return ERROR_VALIDATION_FAILURE if XrSpaceSaveInfoFB::space is NULL_HANDLE or otherwise invalid. The runtime must return ERROR_VALIDATION_FAILURE if XrSpaceSaveInfoFB::location or XrSpaceSaveInfoFB::persistenceMode is invalid. This operation is asynchronous and the runtime must post an XrEventDataSpaceSaveCompleteFB 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 extension must be enabled prior to calling SaveSpaceFB
• session must be a valid XrSession handle
• info must be a pointer to a valid XrSpaceSaveInfoFB 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_NOT_ENABLED_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrSpaceSaveInfoFB, EraseSpaceFB

Parameters

session:XrSession

a handle to an XrSession.

info:XrSpaceSaveInfoFB

contains the parameters for the save operation.

requestId:LongBuffer

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

Annotations

@NativeType:XrResult