C Specification

The xrStopHapticFeedback function is defined as:

XrResult xrStopHapticFeedback(
    XrAction                                    hapticAction,
    uint32_t                                    countSubactionPaths,
    const XrPath*                               subactionPaths);

Parameters

Parameter Descriptions
  • hapticAction is the XrAction handle for the desired output action.

  • 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. The runtime must only stop haptic output on the specified devices. If this parameter is specified, the runtime must return data that originates only on the paths specified in this array.

Description

If a haptic event from this XrAction is in progress, when this function is called the runtime must stop that event. See XrActionCreateInfo for a description of subaction paths, and the restrictions on their use.

Valid Usage (Implicit)
  • hapticAction 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

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_VALIDATION_FAILURE

  • XR_ERROR_ACTION_TYPE_MISMATCH

  • XR_ERROR_SESSION_NOT_RUNNING

See Also

Document Notes

For more information, see the OpenXR Specification at URL

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

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