C Specification

The xrShareSpacesFB function is defined as:

// Provided by XR_FB_spatial_entity_sharing
XrResult xrShareSpacesFB(
    XrSession                                   session,
    const XrSpaceShareInfoFB*                   info,
    XrAsyncRequestIdFB*                         requestId);

Parameters

Parameter Descriptions

  • session is a handle to an XrSession.

  • info is a pointer to an XrSpaceShareInfoFB structure containing information about which spatial entities to share with which users.

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

Description

This operation is asynchronous and the runtime must post an XrEventDataSpaceShareCompleteFB event when the operation completes successfully or encounters an error. If this function returns a failure code, no event is posted. The requestId can be used to later refer to the request, such as identifying which request has completed when an XrEventDataSpaceShareCompleteFB is posted to the event queue.

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_NETWORK_TIMEOUT_FB

  • XR_ERROR_SPACE_NETWORK_REQUEST_FAILED_FB

  • XR_ERROR_SPACE_MAPPING_INSUFFICIENT_FB

  • XR_ERROR_SPACE_LOCALIZATION_FAILED_FB

  • XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB

  • XR_ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

  • XR_ERROR_FEATURE_UNSUPPORTED

See Also

XR_FB_spatial_entity_sharing, XrAsyncRequestIdFB, XrSession, XrSpaceShareInfoFB

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.