C Specification

The xrRequestBoundaryVisibilityMETA function is defined as:

// Provided by XR_META_boundary_visibility
XrResult xrRequestBoundaryVisibilityMETA(
    XrSession                                   session,
    XrBoundaryVisibilityMETA                    boundaryVisibility);

Parameters

Parameter Descriptions

Description

The xrRequestBoundaryVisibilityMETA function is used by the application to request a specific boundary visibility represented with XrBoundaryVisibilityMETA. The function returns XR_SUCCESS if the runtime accepted the request. The function returns XR_BOUNDARY_VISIBILITY_SUPPRESSION_NOT_ALLOWED_META if the runtime did not accept the request to suppress the boundary visibility depending on runtime-specific conditions. An example of the runtime-specific conditions preventing the boundary visibility from changing may be the application fully obscuring the real world environment. The application can request suppressing the boundary visibility later again, and the runtime may accept the new request when the conditions are met.

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

  • XR_SUCCESS

  • XR_BOUNDARY_VISIBILITY_SUPPRESSION_NOT_ALLOWED_META

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_FEATURE_UNSUPPORTED

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_META_boundary_visibility, XrBoundaryVisibilityMETA, XrEventDataBoundaryVisibilityChangedMETA, XrSession

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.