C Specification

The xrCreateEnvironmentRaycasterAsyncMETA function is defined as:

// Provided by XR_META_environment_raycast
XrResult xrCreateEnvironmentRaycasterAsyncMETA(
    XrSession                                   session,
    const XrEnvironmentRaycasterCreateInfoMETA* info,
    XrFutureEXT*                                future);

Parameters

Parameter Descriptions

Description

This function starts an asynchronous operation and creates a corresponding XrFutureEXT, usable with xrPollFutureEXT and related functions. The return value of this function only indicates whether the parameters were acceptable to schedule the asynchronous operation. The corresponding completion function is xrCreateEnvironmentRaycasterCompleteMETA, usable when a future from this function is in the READY state, with outputs populated by that function in the completion structure XrEnvironmentRaycasterCreateCompletionMETA.

Runtimes may initialize needed resources to perform raycast operations during this asynchronous call.

If the system does not support environment raycast operations, the runtime must return XR_ERROR_FEATURE_UNSUPPORTED from xrCreateEnvironmentRaycasterAsyncMETA. In this case, the runtime must return XR_FALSE for XrSystemEnvironmentRaycastPropertiesMETA::supportsEnvironmentRaycast when the function xrGetSystemProperties is called, so that the application can avoid attempting to create an environment raycaster.

Valid Usage (Implicit)
Return Codes
On success, this command returns

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_FEATURE_UNSUPPORTED

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_LIMIT_REACHED

  • XR_ERROR_OUT_OF_MEMORY

  • XR_ERROR_PERMISSION_INSUFFICIENT

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_META_environment_raycast, XrEnvironmentRaycasterCreateInfoMETA, XrFutureEXT, 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.