C Specification

The runtime must fill out the XrSceneObjectsMSFT structure when included in the XrSceneComponentsMSFT::next chain. The XrSceneComponentsGetInfoMSFT::componentType must be XR_SCENE_COMPONENT_TYPE_OBJECT_MSFT when XrSceneObjectsMSFT is included in the next chain. If it is not, the XR_ERROR_SCENE_COMPONENT_TYPE_MISMATCH_MSFT error must be returned.

The XrSceneObjectsMSFT structure is defined as:

// Provided by XR_MSFT_scene_understanding
typedef struct XrSceneObjectsMSFT {
    XrStructureType       type;
    void*                 next;
    uint32_t              sceneObjectCount;
    XrSceneObjectMSFT*    sceneObjects;
} XrSceneObjectsMSFT;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

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

  • sceneObjectCount is a uint32_t describing the count of elements in the sceneObjects array.

  • sceneObjects is an array of XrSceneObjectMSFT.

Description

The runtime must only set XrSceneObjectMSFT::objectType to any of the following XrSceneObjectTypeMSFT values:

  • XR_SCENE_OBJECT_TYPE_UNCATEGORIZED_MSFT

  • XR_SCENE_OBJECT_TYPE_BACKGROUND_MSFT

  • XR_SCENE_OBJECT_TYPE_WALL_MSFT

  • XR_SCENE_OBJECT_TYPE_FLOOR_MSFT

  • XR_SCENE_OBJECT_TYPE_CEILING_MSFT

  • XR_SCENE_OBJECT_TYPE_PLATFORM_MSFT

  • XR_SCENE_OBJECT_TYPE_INFERRED_MSFT

Valid Usage (Implicit)

See Also

XR_MSFT_scene_understanding, XrSceneComponentsMSFT, XrSceneObjectMSFT, XrStructureType

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.