public Class XrInteractionProfileDpadBindingEXT

Description

The XrInteractionProfileDpadBindingEXT structure is an input struct that defines how to use any two-axis input to provide dpad-like functionality to the application. The struct must be added for each input that should be treated as a dpad to the bindingModifications array of the XrBindingModificationsKHR structure (See XR_KHR_binding_modification extension).

Runtimes are free to ignore any of the fields when not obeying the bindings, but may use it for automatic rebindings of actions.

The implementation must return ERROR_VALIDATION_FAILURE from SuggestInteractionProfileBindings if any of the following are true:

• forceThreshold or forceThresholdReleased are outside the half-open range (0, 1]
• forceThreshold < forceThresholdReleased
• centerRegion is outside the exclusive range (0, 1)
• wedgeAngle outside the half-open range [0, π)

If more than one XrInteractionProfileDpadBindingEXT is provided for the same input identifier, including top level path (e.g. pathname:/user/hand/left/input/thumbstick), and two or more of them specify the same actionset, the runtime must return ERROR_VALIDATION_FAILURE. If the same input identifier, including top level path, is used for more than one action set, in addition to inputs being suppressed by higher priority action sets, haptic events from dpads are also suppressed.

For example, a Valve Index controller binding with a "Walking" action set can have a dpad on each of:

• left thumbstick
• right thumbstick
• left trackpad
• right trackpad

Another action set can also have a dpad active on each of those inputs, and they can have different settings. If both action sets are active, the higher priority one trumps the lower priority one, and the lower priority one is suppressed.

Valid Usage (Implicit)

• The XR_EXT_dpad_binding extension must be enabled prior to using XrInteractionProfileDpadBindingEXT
• type must be TYPE_INTERACTION_PROFILE_DPAD_BINDING_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• actionSet must be a valid XrActionSet 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

XrBindingModificationBaseHeaderKHR, XrHapticBaseHeader, SuggestInteractionProfileBindings

Layout

struct XrInteractionProfileDpadBindingEXT {
    XrStructureType type;
    void const * next;
    XrPath binding;
    XrActionSet actionSet;
    float forceThreshold;
    float forceThresholdReleased;
    float centerRegion;
    float wedgeAngle;
    XrBool32 isSticky;
    XrHapticBaseHeader const * onHaptic;
    XrHapticBaseHeader const * offHaptic;
}