XrSceneComponentsMSFT(3)

C Specification

The XrSceneComponentsMSFT structure contains an array of XrSceneComponentMSFT returning the components that satisfy the conditions in xrGetSceneComponentsMSFT::getInfo. The XrSceneComponentsMSFT structure is defined as:

// Provided by XR_MSFT_scene_understanding
typedef struct XrSceneComponentsMSFT {
    XrStructureType          type;
    void*                    next;
    uint32_t                 componentCapacityInput;
    uint32_t                 componentCountOutput;
    XrSceneComponentMSFT*    components;
} XrSceneComponentsMSFT;

Members

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to the next structure in a structure chain.
componentCapacityInput is the capacity of the array, or 0 to indicate a request to retrieve the required capacity.
componentCountOutput is a pointer to the count of components, or a pointer to the required capacity in the case that componentCapacityInput is insufficient.
components is an array of XrSceneComponentMSFT.
See the https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#fundamentals-buffer-size-parameters section for a detailed description of retrieving the required components size.

Description

Valid Usage (Implicit)

The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneComponentsMSFT
type must be XR_TYPE_SCENE_COMPONENTS_MSFT
next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrSceneMarkerQRCodesMSFT, XrSceneMarkersMSFT, XrSceneMeshesMSFT, XrSceneObjectsMSFT, XrScenePlanesMSFT
If componentCapacityInput is not 0, components must be a pointer to an array of componentCapacityInput XrSceneComponentMSFT structures

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

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

XrSceneComponentsMSFT(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright