C Specification

The xrGetSpaceBoundingBox2DFB function is defined as:

// Provided by XR_FB_scene
XrResult xrGetSpaceBoundingBox2DFB(
    XrSession                                   session,
    XrSpace                                     space,
    XrRect2Df*                                  boundingBox2DOutput);

Parameters

Parameter Descriptions

  • session is a handle to an XrSession.

  • space is the XrSpace handle to the spatial entity.

  • boundingBox2DOutput is an output parameter pointing to the structure containing the 2D bounding box for space.

Description

Gets the 2D bounding box for a spatial entity with the XR_SPACE_COMPONENT_TYPE_BOUNDED_2D_FB component type enabled.

The bounding box is defined by an XrRect2Df::offset and XrRect2Df::extent. The XrRect2Df::offset refers to the coordinate of the minimum corner of the box in the x-y plane of the given XrSpace’s coordinate system; that is, the corner whose coordinate has the minimum value on each axis. The XrRect2Df::extent refers to the dimensions of the box along each axis. The maximum corner can therefore be computed as XrRect2Df::offset
XrRect2Df::extent.

Valid Usage (Implicit)
Return Codes
On success, this command returns

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_VALIDATION_FAILURE

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB

  • XR_ERROR_FEATURE_UNSUPPORTED

See Also

XR_FB_scene, XrRect2Df, XrSession, XrSpace

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.