C Specification

The XrSceneMarkerTypeFilterMSFT structure is defined as:

// Provided by XR_MSFT_scene_marker
typedef struct XrSceneMarkerTypeFilterMSFT {
    XrStructureType           type;
    const void*               next;
    uint32_t                  markerTypeCount;
    XrSceneMarkerTypeMSFT*    markerTypes;
} XrSceneMarkerTypeFilterMSFT;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain.

  • markerTypeCount is a uint32_t indicating the count of elements in the markerTypes array.

  • markerTypes is an array of XrSceneMarkerTypeMSFT indicating the types of markers to return.

Description

The application can filter the returned scene components to specific marker types by chaining XrSceneMarkerTypeFilterMSFT to the next pointer of XrSceneComponentsGetInfoMSFT when calling xrGetSceneComponentsMSFT.

When XrSceneMarkerTypeFilterMSFT is provided to xrGetSceneComponentsMSFT, the runtime must only return scene components that match the requested types.

The application must provide a non-empty array of unique markerTypes, i.e. the markerTypeCount must be positive and the elements in the markerTypes array must not have duplicated values. Otherwise, the runtime must return XR_ERROR_VALIDATION_FAILURE for xrGetSceneComponentsMSFT function.

Valid Usage (Implicit)

See Also

XR_MSFT_scene_marker, XrSceneMarkerTypeMSFT, XrStructureType, xrGetSceneComponentsMSFT

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2024, The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.