C Specification

The xrCreateLightEstimatorANDROID function is defined as:

// Provided by XR_ANDROID_light_estimation
XrResult xrCreateLightEstimatorANDROID(
    XrSession                                   session,
    XrLightEstimatorCreateInfoANDROID*          createInfo,
    XrLightEstimatorANDROID*                    outHandle);

Parameters

Parameter Descriptions

Description

The application uses the xrCreateLightEstimatorANDROID function to create a light estimator.

  • The runtime must return XR_ERROR_FEATURE_UNSUPPORTED if the system does not support light estimation.

  • The runtime must return XR_ERROR_PERMISSION_INSUFFICIENT if the required permissions have not been granted to the calling app.

If an application wants to indicate to the runtime that it is done accessing light estimation data it must destroy the handle via xrDestroyLightEstimatorANDROID.

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_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_LIMIT_REACHED

  • XR_ERROR_OUT_OF_MEMORY

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

See Also

XR_ANDROID_light_estimation, XrLightEstimatorANDROID, XrLightEstimatorCreateInfoANDROID, 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.