xrRaycastANDROID(3)

C Specification

The xrRaycastANDROID function is defined as:

// Provided by XR_ANDROID_raycast
XrResult xrRaycastANDROID(
    XrSession                                   session,
    const XrRaycastInfoANDROID*                 rayInfo,
    XrRaycastHitResultsANDROID*                 results);

Parameters

Parameter Descriptions

session is the XrSession that the raycast is performed in.
rayInfo is the XrRaycastInfoANDROID that describes the ray to cast.
results is a pointer to the XrRaycastHitResultsANDROID that receives the results of the raycast.

Description

To perform raycasts, the application calls xrRaycastANDROID.

If a raycast intersects more trackables than XrRaycastInfoANDROID::maxResults, the runtime must return the hit results that are closest to the XrRaycastInfoANDROID::origin of the ray.
If a raycast intersects a trackable of type XR_TRACKABLE_TYPE_PLANE_ANDROID, that is subsumed by another plane, the runtime must return the hit result for the subsuming plane only.
The runtime must return the hit results in closest-to-farthest order from XrRaycastInfoANDROID::origin along the XrRaycastInfoANDROID::trajectory vector.
The runtime must return XR_ERROR_TRACKABLE_TYPE_NOT_SUPPORTED_ANDROID if the trackable type corresponding to the XrTrackableTrackerANDROID handles in XrRaycastInfoANDROID::trackers are not enumerated by xrEnumerateRaycastSupportedTrackableTypesANDROID.

Valid Usage (Implicit)

The XR_ANDROID_raycast extension must be enabled prior to calling xrRaycastANDROID
session must be a valid XrSession handle
rayInfo must be a pointer to a valid XrRaycastInfoANDROID structure
results must be a pointer to an XrRaycastHitResultsANDROID structure

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
XR_ERROR_OUT_OF_MEMORY
XR_ERROR_LIMIT_REACHED
XR_ERROR_TRACKABLE_TYPE_NOT_SUPPORTED_ANDROID
XR_ERROR_TIME_INVALID
XR_ERROR_POSE_INVALID
XR_ERROR_FEATURE_UNSUPPORTED

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.

xrRaycastANDROID(3) Manual Page

Name

C Specification

Parameters

Description

See Also

Document Notes

Copyright