C Specification

The xrSetHandTrackingFrequencyHintMETA function provides a frequency hint to the runtime to suggest the desired hand tracking update frequency for the session.

// Provided by XR_META_hand_tracking_frequency_hint
XrResult xrSetHandTrackingFrequencyHintMETA(
    XrSession                                   session,
    XrHandTrackingFrequencyHintMETA             frequencyHint);

Parameters

Parameter Descriptions

  • session is an XrSession handle previously created with xrCreateSession.

  • frequencyHint is the frequency hint that the application suggests to the runtime.

Description

xrSetHandTrackingFrequencyHintMETA provides a frequency hint to the runtime to suggest the desired hand tracking update frequency for the session. This is a suggestion mechanism only, and the runtime may choose to ignore the hint based on user preferences, system constraints, power management policies, or other considerations. Applications should not rely on the runtime honoring the frequency hint and should be prepared to handle hand tracking data at any supported frequency.

The frequency hint remains active until changed by another call to xrSetHandTrackingFrequencyHintMETA or until the session is destroyed.

Applications can call this function multiple times during a session to adjust the frequency hint based on changing application requirements.

The runtime may change the actual hand tracking frequency at any time, regardless of the frequency hint, and applications should be prepared to handle hand tracking data at any supported frequency.

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

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_META_hand_tracking_frequency_hint, XrHandTrackingFrequencyHintMETA, 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.