C Specification

The xrGetActionStateVector1f function is defined as:

XrResult xrGetActionStateVector1f(
    XrAction                                    action,
    uint32_t                                    countSubactionPaths,
    const XrPath*                               subactionPaths,
    XrActionStateVector1f*                      data);

Parameters

Parameter Descriptions

  • action is the XrAction being queried.

  • countSubactionPaths is the number of elements in the subactionPaths array. If subactionPaths is NULL, this parameter must be 0.

  • subactionPaths is an array of paths or NULL. If this array is specified, it contains one or more subaction paths that were specified when the action was created. If the array includes a subaction path that was not specified when the action was created the runtime must return XR_ERROR_PATH_INVALID. If this parameter is specified, the runtime must return data that originates only on the paths specified in this array.

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

Description

xrGetActionStateVector1f retrieves the current state of a one-dimensional vector action. See XrActionCreateInfo for a description of subaction paths, and the restrictions on their use.

Valid Usage (Implicit)

  • action must be a valid XrAction handle

  • If countSubactionPaths is not 0, countSubactionPaths must be a valid uint32_t value

  • If countSubactionPaths is not 0, subactionPaths must be a pointer to an array of countSubactionPaths XrPath values

  • data must be a pointer to an XrActionStateVector1f structure

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, XrActionStateVector1f, XrPath, xrCreateAction

Document Notes

For more information, see the OpenXR Specification at URL

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

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.