Package org.lwjgl.openxr

Class MSFTSceneUnderstandingSerialization

java.lang.Object

org.lwjgl.openxr.MSFTSceneUnderstandingSerialization

public class MSFTSceneUnderstandingSerialization
extends Object

The XR_MSFT_scene_understanding_serialization extension.

This extension extends the scene understanding extension and enables scenes to be serialized or deserialized. It enables computing a new scene into a serialized binary stream and it enables deserializing a binary stream into an XrSceneMSFT handle.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_MSFT_SCENE_UNDERSTANDING_SERIALIZATION_EXTENSION_NAME	The extension name.
static final int	XR_MSFT_scene_understanding_serialization_SPEC_VERSION	The extension specification version.
static final int	XR_SCENE_COMPONENT_TYPE_SERIALIZED_SCENE_FRAGMENT_MSFT	Extends XrSceneComponentTypeMSFT.
static final int	XR_SCENE_COMPUTE_FEATURE_SERIALIZE_SCENE_MSFT	Extends XrSceneComputeFeatureMSFT.
static final int	XR_TYPE_SCENE_DESERIALIZE_INFO_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SERIALIZED_SCENE_FRAGMENT_DATA_GET_INFO_MSFT	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrDeserializeSceneMSFT(XrSceneObserverMSFT sceneObserver, long deserializeInfo)	Unsafe version of: DeserializeSceneMSFT
static int	nxrGetSerializedSceneFragmentDataMSFT(XrSceneMSFT scene, long getInfo, int countInput, long readOutput, long buffer)	Unsafe version of: GetSerializedSceneFragmentDataMSFT
static int	xrDeserializeSceneMSFT(XrSceneObserverMSFT sceneObserver, XrSceneDeserializeInfoMSFT deserializeInfo)	Deserialize scene.
static int	xrGetSerializedSceneFragmentDataMSFT(XrSceneMSFT scene, XrSerializedSceneFragmentDataGetInfoMSFT getInfo, IntBuffer readOutput, @Nullable ByteBuffer buffer)	Get serialized scene fragment data.

Methods inherited from class java.lang.Object

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

Field Details

XR_MSFT_scene_understanding_serialization_SPEC_VERSION

public static final int XR_MSFT_scene_understanding_serialization_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_MSFT_SCENE_UNDERSTANDING_SERIALIZATION_EXTENSION_NAME

public static final String XR_MSFT_SCENE_UNDERSTANDING_SERIALIZATION_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SERIALIZED_SCENE_FRAGMENT_DATA_GET_INFO_MSFT

public static final int XR_TYPE_SERIALIZED_SCENE_FRAGMENT_DATA_GET_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SERIALIZED_SCENE_FRAGMENT_DATA_GET_INFO_MSFT
• TYPE_SCENE_DESERIALIZE_INFO_MSFT

See Also:

• Constant Field Values

XR_TYPE_SCENE_DESERIALIZE_INFO_MSFT

public static final int XR_TYPE_SCENE_DESERIALIZE_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SERIALIZED_SCENE_FRAGMENT_DATA_GET_INFO_MSFT
• TYPE_SCENE_DESERIALIZE_INFO_MSFT

See Also:

• Constant Field Values

XR_SCENE_COMPUTE_FEATURE_SERIALIZE_SCENE_MSFT

public static final int XR_SCENE_COMPUTE_FEATURE_SERIALIZE_SCENE_MSFT

Extends XrSceneComputeFeatureMSFT.

See Also:

• Constant Field Values

XR_SCENE_COMPONENT_TYPE_SERIALIZED_SCENE_FRAGMENT_MSFT

public static final int XR_SCENE_COMPONENT_TYPE_SERIALIZED_SCENE_FRAGMENT_MSFT

Extends XrSceneComponentTypeMSFT.

See Also:

• Constant Field Values

Method Details

nxrDeserializeSceneMSFT

public static int nxrDeserializeSceneMSFT(XrSceneObserverMSFT sceneObserver,
 long deserializeInfo)

Unsafe version of: DeserializeSceneMSFT

xrDeserializeSceneMSFT

public static int xrDeserializeSceneMSFT(XrSceneObserverMSFT sceneObserver,
 XrSceneDeserializeInfoMSFT deserializeInfo)

Deserialize scene.

C Specification

The DeserializeSceneMSFT function is defined as:

 XrResult xrDeserializeSceneMSFT(
     XrSceneObserverMSFT                         sceneObserver,
     const XrSceneDeserializeInfoMSFT*           deserializeInfo);

Description

The DeserializeSceneMSFT function begins deserializing a list of serialized scene fragments. The runtime must return quickly without waiting for the deserialization to complete. The application should use GetSceneComputeStateMSFT to inspect the completeness of the deserialization.

The runtime must return ERROR_COMPUTE_NEW_SCENE_NOT_COMPLETED_MSFT if DeserializeSceneMSFT is called while the scene computation is in progress.

The GetSceneComputeStateMSFT function must return SCENE_COMPUTE_STATE_UPDATING_MSFT while the deserialization is in progress, and SCENE_COMPUTE_STATE_COMPLETED_MSFT when the deserialization has completed successfully. If the runtime fails to deserialize the binary stream, GetSceneComputeStateMSFT must return SCENE_COMPUTE_STATE_COMPLETED_WITH_ERROR_MSFT to indicate that the deserialization has completed but an error occurred.

When GetSceneComputeStateMSFT returns SCENE_COMPUTE_STATE_COMPLETED_MSFT, the application may call CreateSceneMSFT to create the XrSceneMSFT handle. If CreateSceneMSFT is called while GetSceneComputeStateMSFT returns SCENE_COMPUTE_STATE_COMPLETED_WITH_ERROR_MSFT, a valid XrSceneMSFT handle must be returned, but that handle must contain zero scene components.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding_serialization extension must be enabled prior to calling DeserializeSceneMSFT
• sceneObserver must be a valid XrSceneObserverMSFT handle
• deserializeInfo must be a pointer to a valid XrSceneDeserializeInfoMSFT 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_OUT_OF_MEMORY
• ERROR_COMPUTE_NEW_SCENE_NOT_COMPLETED_MSFT

See Also

XrSceneDeserializeInfoMSFT

Parameters:

sceneObserver - a handle to an XrSceneObserverMSFT previously created with CreateSceneObserverMSFT.

deserializeInfo - a pointer to an XrSceneDeserializeInfoMSFT structure.

nxrGetSerializedSceneFragmentDataMSFT

public static int nxrGetSerializedSceneFragmentDataMSFT(XrSceneMSFT scene,
 long getInfo,
 int countInput,
 long readOutput,
 long buffer)

Unsafe version of: GetSerializedSceneFragmentDataMSFT

Parameters:

countInput - the number of bytes that should be read.

xrGetSerializedSceneFragmentDataMSFT

public static int xrGetSerializedSceneFragmentDataMSFT(XrSceneMSFT scene,
 XrSerializedSceneFragmentDataGetInfoMSFT getInfo,
 IntBuffer readOutput,
 @Nullable ByteBuffer buffer)

Get serialized scene fragment data.

C Specification

The application can call the GetSerializedSceneFragmentDataMSFT function to read the binary data of a serialized scene fragment from the XrSceneMSFT handle. This function follows the two-call idiom for filling the buffer.

The GetSerializedSceneFragmentDataMSFT function is defined as:

 XrResult xrGetSerializedSceneFragmentDataMSFT(
     XrSceneMSFT                                 scene,
     const XrSerializedSceneFragmentDataGetInfoMSFT* getInfo,
     uint32_t                                    countInput,
     uint32_t*                                   readOutput,
     uint8_t*                                    buffer);

Description

The runtime must return ERROR_SCENE_COMPONENT_ID_INVALID_MSFT if the given scene fragment XrUuidMSFT was not found.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding_serialization extension must be enabled prior to calling GetSerializedSceneFragmentDataMSFT
• scene must be a valid XrSceneMSFT handle
• getInfo must be a pointer to a valid XrSerializedSceneFragmentDataGetInfoMSFT structure
• readOutput must be a pointer to a uint32_t value
• If countInput is not 0, buffer must be a pointer to an array of countInput uint8_t 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_OUT_OF_MEMORY
• ERROR_SIZE_INSUFFICIENT
• ERROR_SCENE_COMPONENT_ID_INVALID_MSFT

See Also

XrSerializedSceneFragmentDataGetInfoMSFT

Parameters:

scene - the XrSceneMSFT handle to read from.

getInfo - a pointer to an XrSerializedSceneFragmentDataGetInfoMSFT structure.

readOutput - the number of bytes read.

buffer - a pointer to the buffer where the data should be copied.