public Class XrInteractionProfileAnalogThresholdVALVE

Description

Applications can also chain a single XrInteractionProfileAnalogThresholdVALVE structure on the next chain of any SuggestInteractionProfileBindings call. Runtimes must support this kind of chaining. This method of specifying analog thresholds is deprecated however, and should not be used by any new applications.

If a threshold struct is present for a given conversion, the runtime must use those thresholds instead of applying its own whenever it is using the binding suggested by the application.

onThreshold and offThreshold permit allow the application to specify that it wants hysteresis to be applied to the threshold operation. If onThreshold is smaller than offThreshold, the runtime must return ERROR_VALIDATION_FAILURE.

onHaptic and offHaptic allow the application to specify that it wants automatic haptic feedback to be generated when the boolean output of the threshold operation changes from false to true or vice versa. If these fields are not NULL, the runtime must trigger a haptic output with the specified characteristics. If the device has multiple haptic outputs, the runtime should use the haptic output that is most appropriate for the specified input path.

If a suggested binding with action and binding is not in the binding list for this interaction profile, the runtime must return ERROR_PATH_UNSUPPORTED.

Valid Usage (Implicit)

• The XR_VALVE_analog_threshold extension must be enabled prior to using XrInteractionProfileAnalogThresholdVALVE
• type must be TYPE_INTERACTION_PROFILE_ANALOG_THRESHOLD_VALVE
• next must be NULL or a valid pointer to the next structure in a structure chain
• action must be a valid XrAction handle
• If onHaptic is not NULL, onHaptic must be a pointer to a valid XrHapticBaseHeader-based structure. See also: XrHapticAmplitudeEnvelopeVibrationFB, XrHapticPcmVibrationFB, XrHapticVibration
• If offHaptic is not NULL, offHaptic must be a pointer to a valid XrHapticBaseHeader-based structure. See also: XrHapticAmplitudeEnvelopeVibrationFB, XrHapticPcmVibrationFB, XrHapticVibration

See Also

XrHapticBaseHeader

Layout

struct XrInteractionProfileAnalogThresholdVALVE {
    XrStructureType type;
    void const * next;
    XrAction action;
    XrPath binding;
    float onThreshold;
    float offThreshold;
    XrHapticBaseHeader const * onHaptic;
    XrHapticBaseHeader const * offHaptic;
}