xrPerformEnvironmentRaycastMETA(3)

C Specification

The xrPerformEnvironmentRaycastMETA function is defined as:

// Provided by XR_META_environment_raycast
XrResult xrPerformEnvironmentRaycastMETA(
    XrEnvironmentRaycasterMETA                  environmentRaycaster,
    const XrEnvironmentRaycastHitGetInfoMETA*   info,
    XrEnvironmentRaycastHitMETA*                hitPoint);

Parameters

Parameter Descriptions

environmentRaycaster is an XrEnvironmentRaycasterMETA previously created by xrCreateEnvironmentRaycasterAsyncMETA.
info is a pointer to an XrEnvironmentRaycastHitGetInfoMETA describing the ray to cast.
hitPoint is a pointer to XrEnvironmentRaycastHitMETA that the runtime fills with information about where the closest hit is, if found.

Description

The xrPerformEnvironmentRaycastMETA function is used by the application to perform an environment raycast operation.

Valid Usage (Implicit)

The XR_META_environment_raycast extension must be enabled prior to calling xrPerformEnvironmentRaycastMETA
environmentRaycaster must be a valid XrEnvironmentRaycasterMETA handle
info must be a pointer to a valid XrEnvironmentRaycastHitGetInfoMETA structure
hitPoint must be a pointer to an XrEnvironmentRaycastHitMETA structure

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_OUT_OF_MEMORY
XR_ERROR_RUNTIME_FAILURE
XR_ERROR_SESSION_LOST
XR_ERROR_TIME_INVALID
XR_ERROR_VALIDATION_FAILURE

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

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

xrPerformEnvironmentRaycastMETA(3) Manual Page

Name

C Specification

Parameters

Description

See Also

Document Notes

Copyright