C Specification

The XrRoomMeshFaceIndicesMETA structure is defined as:

// Provided by XR_META_spatial_entity_room_mesh
typedef struct XrRoomMeshFaceIndicesMETA {
    XrStructureType    type;
    void*              next;
    uint32_t           indexCapacityInput;
    uint32_t           indexCountOutput;
    uint32_t*          indices;
} XrRoomMeshFaceIndicesMETA;

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.

  • indexCapacityInput is an input parameter for the application to specify the capacity of the indices array, or 0 to indicate a request to retrieve the required capacity.

  • indexCountOutput is an output parameter that will hold the number of indices written in the output array, or the required capacity in the case that indexCapacityInput is insufficient. The returned value must be a multiple of 3.

  • indices is a pointer to an array of uint32_t, but can be NULL if indexCapacityInput is 0.

  • 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 indices array sizes.

Description

The XrRoomMeshFaceIndicesMETA structure can be used by the application to perform the two calls required to obtain indices of a face of a room mesh associated with a specified spatial entity.

The geometry of a face is represented as a set of triangles. The output values written in the indices array represent indices of the vertices obtained in XrRoomMeshMETA::vertices. Three consecutive elements represent a triangle with a counter-clockwise winding order. Each face of a room mesh must be a planar face; i.e. the vertices of a face must be coplanar.

Valid Usage (Implicit)

See Also

XR_META_spatial_entity_room_mesh, XrStructureType, xrGetSpaceRoomMeshFaceIndicesMETA

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

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