Package org.lwjgl.openxr

Class MSFTSceneMarker

java.lang.Object

org.lwjgl.openxr.MSFTSceneMarker

public class MSFTSceneMarker
extends Object

The XR_MSFT_scene_marker extension.

This extension enables the application to observe the tracked markers, such as the QR Code markers in ISO/IEC 18004:2015. This extension also enables future extensions to easily add new types of marker tracking.

The application must enable both XR_MSFT_scene_marker and XR_MSFT_scene_understanding in order to use this extension.

Note

A typical use of this extension is:

• Verify if marker detection is supported by calling EnumerateSceneComputeFeaturesMSFT and validate that the returned supported features include SCENE_COMPUTE_FEATURE_MARKER_MSFT.
• If supported, create an XrSceneObserverMSFT handle.
• Pass in SCENE_COMPUTE_FEATURE_MARKER_MSFT as requested feature when starting the scene compute by calling ComputeNewSceneMSFT function.
• Inspect the completion of computation by polling GetSceneComputeStateMSFT.
• Once compute is successfully completed, create an XrSceneMSFT handle to the result by calling CreateSceneMSFT.
• Get the list of detected markers using GetSceneComponentsMSFT:
  • optionally filter the type of the returned markers using XrSceneMarkerTypeFilterMSFT.
  • optionally retrieve additional marker properties by chaining XrSceneMarkersMSFT and/or XrSceneMarkerQRCodesMSFT to the next pointer of XrSceneComponentsMSFT.
• Get the data encoded in a marker using GetSceneMarkerDecodedStringMSFT or GetSceneMarkerRawDataMSFT.
• Locate markers using LocateSceneComponentsMSFT.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_MSFT_SCENE_MARKER_EXTENSION_NAME	The extension name.
static final int	XR_MSFT_scene_marker_SPEC_VERSION	The extension specification version.
static final int	XR_SCENE_COMPONENT_TYPE_MARKER_MSFT	Extends XrSceneComponentTypeMSFT.
static final int	XR_SCENE_COMPUTE_FEATURE_MARKER_MSFT	Extends XrSceneComputeFeatureMSFT.
static final int	XR_SCENE_MARKER_DATA_NOT_STRING_MSFT	Extends XrResult.
static final int	XR_SCENE_MARKER_QR_CODE_SYMBOL_TYPE_MICRO_QR_CODE_MSFT	XrSceneMarkerQRCodeSymbolTypeMSFT - QR Code Symbol type
static final int	XR_SCENE_MARKER_QR_CODE_SYMBOL_TYPE_QR_CODE_MSFT	XrSceneMarkerQRCodeSymbolTypeMSFT - QR Code Symbol type
static final int	XR_SCENE_MARKER_TYPE_QR_CODE_MSFT	XrSceneMarkerTypeMSFT - Marker type
static final int	XR_TYPE_SCENE_MARKER_QR_CODES_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SCENE_MARKER_TYPE_FILTER_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SCENE_MARKERS_MSFT	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrGetSceneMarkerDecodedStringMSFT(XrSceneMSFT scene, long markerId, int bufferCapacityInput, long bufferCountOutput, long buffer)	Unsafe version of: GetSceneMarkerDecodedStringMSFT
static int	nxrGetSceneMarkerRawDataMSFT(XrSceneMSFT scene, long markerId, int bufferCapacityInput, long bufferCountOutput, long buffer)	Unsafe version of: GetSceneMarkerRawDataMSFT
static int	xrGetSceneMarkerDecodedStringMSFT(XrSceneMSFT scene, XrUuidMSFT markerId, IntBuffer bufferCountOutput, @Nullable ByteBuffer buffer)	Get the string encoded in the scene marker.
static int	xrGetSceneMarkerRawDataMSFT(XrSceneMSFT scene, XrUuidMSFT markerId, IntBuffer bufferCountOutput, @Nullable ByteBuffer buffer)	Get the data stored in the scene marker.

Methods inherited from class java.lang.Object

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

Field Details

XR_MSFT_scene_marker_SPEC_VERSION

public static final int XR_MSFT_scene_marker_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_MSFT_SCENE_MARKER_EXTENSION_NAME

public static final String XR_MSFT_SCENE_MARKER_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_SCENE_COMPUTE_FEATURE_MARKER_MSFT

public static final int XR_SCENE_COMPUTE_FEATURE_MARKER_MSFT

Extends XrSceneComputeFeatureMSFT.

See Also:

• Constant Field Values

XR_SCENE_COMPONENT_TYPE_MARKER_MSFT

public static final int XR_SCENE_COMPONENT_TYPE_MARKER_MSFT

Extends XrSceneComponentTypeMSFT.

See Also:

• Constant Field Values

XR_TYPE_SCENE_MARKERS_MSFT

public static final int XR_TYPE_SCENE_MARKERS_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SCENE_MARKERS_MSFT
• TYPE_SCENE_MARKER_TYPE_FILTER_MSFT
• TYPE_SCENE_MARKER_QR_CODES_MSFT

See Also:

• Constant Field Values

XR_TYPE_SCENE_MARKER_TYPE_FILTER_MSFT

public static final int XR_TYPE_SCENE_MARKER_TYPE_FILTER_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SCENE_MARKERS_MSFT
• TYPE_SCENE_MARKER_TYPE_FILTER_MSFT
• TYPE_SCENE_MARKER_QR_CODES_MSFT

See Also:

• Constant Field Values

XR_TYPE_SCENE_MARKER_QR_CODES_MSFT

public static final int XR_TYPE_SCENE_MARKER_QR_CODES_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SCENE_MARKERS_MSFT
• TYPE_SCENE_MARKER_TYPE_FILTER_MSFT
• TYPE_SCENE_MARKER_QR_CODES_MSFT

See Also:

• Constant Field Values

XR_SCENE_MARKER_DATA_NOT_STRING_MSFT

public static final int XR_SCENE_MARKER_DATA_NOT_STRING_MSFT

Extends XrResult.

See Also:

• Constant Field Values

XR_SCENE_MARKER_TYPE_QR_CODE_MSFT

public static final int XR_SCENE_MARKER_TYPE_QR_CODE_MSFT

XrSceneMarkerTypeMSFT - Marker type

Enumerant Descriptions

• SCENE_MARKER_TYPE_QR_CODE_MSFT represents a marker that follows the ISO standard for QR code in ISO/IEC 18004:2015.

See Also

XrSceneMarkerMSFT, XrSceneMarkerTypeFilterMSFT

See Also:

• Constant Field Values

XR_SCENE_MARKER_QR_CODE_SYMBOL_TYPE_QR_CODE_MSFT

public static final int XR_SCENE_MARKER_QR_CODE_SYMBOL_TYPE_QR_CODE_MSFT

XrSceneMarkerQRCodeSymbolTypeMSFT - QR Code Symbol type

Description

The XrSceneMarkerQRCodeSymbolTypeMSFT identifies the symbol type of the QR Code.

Enumerant Descriptions

• SCENE_MARKER_QR_CODE_SYMBOL_TYPE_QR_CODE_MSFT if the marker is a QR Code.
• SCENE_MARKER_QR_CODE_SYMBOL_TYPE_MICRO_QR_CODE_MSFT if the marker is a Micro QR Code.

See Also

XrSceneMarkerQRCodeMSFT

See Also:

• Constant Field Values

XR_SCENE_MARKER_QR_CODE_SYMBOL_TYPE_MICRO_QR_CODE_MSFT

public static final int XR_SCENE_MARKER_QR_CODE_SYMBOL_TYPE_MICRO_QR_CODE_MSFT

XrSceneMarkerQRCodeSymbolTypeMSFT - QR Code Symbol type

Description

The XrSceneMarkerQRCodeSymbolTypeMSFT identifies the symbol type of the QR Code.

Enumerant Descriptions

• SCENE_MARKER_QR_CODE_SYMBOL_TYPE_QR_CODE_MSFT if the marker is a QR Code.
• SCENE_MARKER_QR_CODE_SYMBOL_TYPE_MICRO_QR_CODE_MSFT if the marker is a Micro QR Code.

See Also

XrSceneMarkerQRCodeMSFT

See Also:

• Constant Field Values

Method Details

nxrGetSceneMarkerRawDataMSFT

public static int nxrGetSceneMarkerRawDataMSFT(XrSceneMSFT scene,
 long markerId,
 int bufferCapacityInput,
 long bufferCountOutput,
 long buffer)

Unsafe version of: GetSceneMarkerRawDataMSFT

Parameters:

bufferCapacityInput - the capacity of the buffer, or 0 to indicate a request to retrieve the required capacity.

xrGetSceneMarkerRawDataMSFT

public static int xrGetSceneMarkerRawDataMSFT(XrSceneMSFT scene,
 XrUuidMSFT markerId,
 IntBuffer bufferCountOutput,
 @Nullable ByteBuffer buffer)

Get the data stored in the scene marker.

C Specification

The GetSceneMarkerRawDataMSFT function is defined as:

 XrResult xrGetSceneMarkerRawDataMSFT(
     XrSceneMSFT                                 scene,
     const XrUuidMSFT*                           markerId,
     uint32_t                                    bufferCapacityInput,
     uint32_t*                                   bufferCountOutput,
     uint8_t*                                    buffer);

Description

The GetSceneMarkerRawDataMSFT function retrieves the data stored in the scene marker.

Valid Usage (Implicit)

• The XR_MSFT_scene_marker extension must be enabled prior to calling GetSceneMarkerRawDataMSFT
• scene must be a valid XrSceneMSFT handle
• markerId must be a pointer to a valid XrUuidMSFT structure
• bufferCountOutput must be a pointer to a uint32_t value
• If bufferCapacityInput is not 0, buffer must be a pointer to an array of bufferCapacityInput 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_TYPE_MISMATCH_MSFT
• ERROR_SCENE_COMPONENT_ID_INVALID_MSFT

See Also

XrUuidMSFT

Parameters:

scene - an XrSceneMSFT previously created by CreateSceneMSFT.

markerId - an XrUuidMSFT identifying the marker, and it is returned previous from XrSceneComponentMSFT when calling GetSceneComponentsMSFT.

bufferCountOutput - a pointer to the count of bytes written, or a pointer to the required capacity in the case that bufferCapacityInput is insufficient.

buffer - a pointer to an application-allocated buffer that will be filled with the data stored in the QR Code. It can be NULL if bufferCapacityInput is 0.

nxrGetSceneMarkerDecodedStringMSFT

public static int nxrGetSceneMarkerDecodedStringMSFT(XrSceneMSFT scene,
 long markerId,
 int bufferCapacityInput,
 long bufferCountOutput,
 long buffer)

Unsafe version of: GetSceneMarkerDecodedStringMSFT

Parameters:

bufferCapacityInput - the capacity of the string buffer, or 0 to indicate a request to retrieve the required capacity.

xrGetSceneMarkerDecodedStringMSFT

public static int xrGetSceneMarkerDecodedStringMSFT(XrSceneMSFT scene,
 XrUuidMSFT markerId,
 IntBuffer bufferCountOutput,
 @Nullable ByteBuffer buffer)

Get the string encoded in the scene marker.

C Specification

The GetSceneMarkerDecodedStringMSFT function is defined as:

 XrResult xrGetSceneMarkerDecodedStringMSFT(
     XrSceneMSFT                                 scene,
     const XrUuidMSFT*                           markerId,
     uint32_t                                    bufferCapacityInput,
     uint32_t*                                   bufferCountOutput,
     char*                                       buffer);

Description

The GetSceneMarkerDecodedStringMSFT function retrieves the string stored in the scene marker as an UTF-8 string, including the terminating '\0'. This function follows the two-call idiom for filling the buffer array.

If the stored data in the marker is not an encoded string, the runtime must return the success code SCENE_MARKER_DATA_NOT_STRING_MSFT, set bufferCountOutput to 1, and make buffer an empty string.

Valid Usage (Implicit)

• The XR_MSFT_scene_marker extension must be enabled prior to calling GetSceneMarkerDecodedStringMSFT
• scene must be a valid XrSceneMSFT handle
• markerId must be a pointer to a valid XrUuidMSFT structure
• bufferCountOutput must be a pointer to a uint32_t value
• If bufferCapacityInput is not 0, buffer must be a pointer to an array of bufferCapacityInput char values

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING
• SCENE_MARKER_DATA_NOT_STRING_MSFT

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_TYPE_MISMATCH_MSFT
• ERROR_SCENE_COMPONENT_ID_INVALID_MSFT

See Also

XrUuidMSFT

Parameters:

scene - an XrSceneMSFT previously created by CreateSceneMSFT.

markerId - an XrUuidMSFT identifying the marker, returned previously from XrSceneComponentMSFT::id when calling GetSceneComponentsMSFT.

bufferCountOutput - a pointer to the count of characters written (including the terminating '\0'), or a pointer to the required capacity in the case that bufferCapacityInput is insufficient.

buffer - a pointer to an application-allocated buffer that will be filled with the string stored in the QR Code. It can be NULL if bufferCapacityInput is 0.