C Specification

The xrStartEnvironmentDepthProviderMETA function is defined as:

// Provided by XR_META_environment_depth
XrResult xrStartEnvironmentDepthProviderMETA(
    XrEnvironmentDepthProviderMETA              environmentDepthProvider);

Parameters

Parameter Descriptions

Description

The xrStartEnvironmentDepthProviderMETA function starts the asynchronous generation of depth maps.

Starting the depth provider may use CPU and GPU resources.

Runtimes must return XR_ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB if xrStartEnvironmentDepthProviderMETA is called on an already started XrEnvironmentDepthProviderMETA.

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_RUNTIME_FAILURE

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB

See Also

XR_META_environment_depth, XrEnvironmentDepthProviderMETA

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-2025 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.