C Specification

The xrGetActionStatePose function is defined as:

XrResult xrGetActionStatePose(
    XrAction                                    action,
    XrPath                                      subactionPath,
    XrActionStatePose*                          data);

Parameters

Parameter Descriptions

  • action is the XrAction being queried.

  • subactionPath is an XrPath or XR_PATH_NULL.

  • data is a pointer to a valid XrActionStatePose into which the state will be placed.

Description

xrGetActionStatePose returns information about the binding and active state for the specified action. To determine the pose of this action at a historical or predicted time, create an action space using xrCreateActionSpace. Then, after each sync, get the pose of this action space within your base space using xrLocateSpace.

See XrActionCreateInfo for a description of subaction paths, and the restrictions on their use. xrGetActionStatePose only accepts a single subaction path to require that the application choose which subaction to use for actions that are intended to be bound to multiple devices at the same time.

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

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_ACTION_TYPE_MISMATCH

  • XR_ERROR_VALIDATION_FAILURE

  • XR_ERROR_SESSION_NOT_RUNNING

See Also

XrAction, XrActionStatePose, XrPath, xrCreateAction, xrCreateActionSpace

Document Notes

For more information, see the OpenXR Specification at URL

https://www.khronos.org/registry/openxr/specs/1.0-extensions/html/xrspec.html#xrGetActionStatePose

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.