C Specification

The XrPlaneDetectorBeginInfoEXT structure describes the information to detect planes.

// Provided by XR_EXT_plane_detection
typedef struct XrPlaneDetectorBeginInfoEXT {
    XrStructureType                          type;
    const void*                              next;
    XrSpace                                  baseSpace;
    XrTime                                   time;
    uint32_t                                 orientationCount;
    const XrPlaneDetectorOrientationEXT*     orientations;
    uint32_t                                 semanticTypeCount;
    const XrPlaneDetectorSemanticTypeEXT*    semanticTypes;
    uint32_t                                 maxPlanes;
    float                                    minArea;
    XrPosef                                  boundingBoxPose;
    XrExtent3DfEXT                           boundingBoxExtent;
} XrPlaneDetectorBeginInfoEXT;

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.

  • baseSpace is the XrSpace that the boundingBoxPose is defined in.

  • time is an XrTime at which to detect the planes.

  • orientationCount the number of elements in the orientations.

  • orientations an array of XrPlaneDetectorOrientationEXT. If this field is null no orientation filtering is applied. If any orientations are present only planes with any of the orientation listed are returned.

  • semanticTypeCount the number of elements in the semanticTypes.

  • semanticTypes an array of XrPlaneDetectorSemanticTypeEXT. If this field is null no semantic type filtering is applied. If any semantic types are present only planes with matching semantic types are returned.

  • maxPlanes is the maximum number of planes the runtime may return. This number must be larger than 0. If the number is 0 the runtime must return XR_ERROR_VALIDATION_FAILURE.

  • minArea is the minimum area in square meters a plane must have to be returned. A runtime may have a lower limit under which planes are not detected regardless of minArea and silently drop planes lower than the internal minimum.

  • boundingBoxPose is the pose of the center of the bounding box of the volume to use for detection in baseSpace.

  • boundingBoxExtent is the extent of the bounding box to use for detection. If any part of a plane falls within the bounding box it should be considered for inclusion subject to the other filters. This means that planes may extend beyond the bounding box. A runtime may have an upper limit on the detection range and silently clip the results to that internally.

Description

Valid Usage (Implicit)

See Also

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 2014-2024, The Khronos Group Inc.