C Specification

The xrHapticParametricGetPropertiesEXT function is defined as:

// Provided by XR_EXT_haptic_parametric
XrResult xrHapticParametricGetPropertiesEXT(
    XrSession                                   session,
    const XrHapticActionInfo*                   hapticActionInfo,
    XrHapticParametricPropertiesEXT*            parametricProperties);

Parameters

Parameter Descriptions

Description

xrHapticParametricGetPropertiesEXT retrieves various properties of a haptic element that relate to parametric haptics.

The action and subaction paths provided by hapticActionInfo identify the haptic element. If multiple haptic elements are identified by hapticActionInfo, the runtime must select a single haptic element.

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

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_ACTIONSET_NOT_ATTACHED

  • XR_ERROR_ACTION_TYPE_MISMATCH

  • XR_ERROR_FEATURE_UNSUPPORTED

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_PATH_INVALID

  • XR_ERROR_PATH_UNSUPPORTED

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_EXT_haptic_parametric, XrHapticActionInfo, XrHapticParametricPropertiesEXT, XrSession

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

Copyright 2014-2026 The Khronos Group Inc.

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