xrGetPassthroughCameraStateANDROID(3)

C Specification

// Provided by XR_ANDROID_passthrough_camera_state
XrResult xrGetPassthroughCameraStateANDROID(
    XrSession                                   session,
    const XrPassthroughCameraStateGetInfoANDROID* getInfo,
    XrPassthroughCameraStateANDROID*            cameraStateOutput);

Parameters

Parameter Descriptions

session is an XrSession handle previously created with xrCreateSession.
getInfo is any info that will affect how camera state is determined.
cameraStateOutput is the current state of the camera.

Description

xrGetPassthroughCameraStateANDROID retrieves the current state of the passthrough camera.

Valid Usage (Implicit)

The XR_ANDROID_passthrough_camera_state extension must be enabled prior to calling xrGetPassthroughCameraStateANDROID
session must be a valid XrSession handle
getInfo must be a pointer to a valid XrPassthroughCameraStateGetInfoANDROID structure
cameraStateOutput must be a pointer to an XrPassthroughCameraStateANDROID value

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

See Also

XR_ANDROID_passthrough_camera_state, XrPassthroughCameraStateANDROID, XrPassthroughCameraStateGetInfoANDROID, 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-2025 The Khronos Group Inc.

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