C Specification

The xrSetSpaceComponentStatusFB function is defined as:

// Provided by XR_FB_spatial_entity
XrResult xrSetSpaceComponentStatusFB(
    XrSpace                                     space,
    const XrSpaceComponentStatusSetInfoFB*      info,
    XrAsyncRequestIdFB*                         requestId);

Parameters

Parameter Descriptions

  • space is the XrSpace handle to the spatial entity.

  • info is a pointer to an XrSpaceComponentStatusSetInfoFB structure containing information about the component to be enabled or disabled.

  • requestId is the output parameter that points to the ID of this asynchronous request.

Description

Enables or disables the specified component for the specified entity. This operation is asynchronous and always returns immediately, regardless of the value of XrSpaceComponentStatusSetInfoFB::timeout. The requestId can be used to later refer to the request, such as identifying which request has completed when an XrEventDataSpaceSetStatusCompleteFB is posted to the event queue. If this function returns a failure code, no event is posted. This function must return XR_ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB if the XrSpace does not support the specified component type.

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_STATUS_PENDING_FB

  • XR_ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB

  • XR_ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB

  • XR_ERROR_FEATURE_UNSUPPORTED

See Also

XR_FB_spatial_entity, XrAsyncRequestIdFB, XrSpace, XrSpaceComponentStatusSetInfoFB

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.