C Specification

The XrSpatialEntityComponentDataPolygonBD structure is defined as:

// Provided by XR_BD_spatial_sensing
typedef struct XrSpatialEntityComponentDataPolygonBD {
    XrStructureType    type;
    void*              next;
    uint32_t           vertexCapacityInput;
    uint32_t           vertexCountOutput;
    XrVector2f*        vertices;
} XrSpatialEntityComponentDataPolygonBD;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

  • vertexCapacityInput is the capacity of the vertices array, or 0 to indicate a request to retrieve the required capacity.

  • vertexCountOutput is the number of elements populated in the vertices array, or the required capacity in the case that vertexCapacityInput is insufficient.

  • vertices is an array of XrVector2f. It can be NULL if vertexCapacityInput is 0.

  • See Buffer Size Parameters chapter for a detailed description of retrieving the required vertices size.

The XrSpatialEntityComponentDataPolygonBD is an output struct for getting the polygon component data from an entity in the snapshot. This corresponds to an XrSpatialEntityComponentTypeBD value of XR_SPATIAL_ENTITY_COMPONENT_TYPE_POLYGON_BD.

Description

The vertices is a list of vertices described on the XY plane, which is defined by the spatial entity’s coordinate space.

Valid Usage (Implicit)

See Also

XR_BD_spatial_sensing, XrStructureType, XrVector2f, xrGetSpatialEntityComponentDataBD

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-2025 The Khronos Group Inc.

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