SDL_HapticCondition(3type)

💖 SDL_HapticCondition 💖

okay bestie, sit down, hydrate, and let me tell you about SDL_HapticCondition — it's a 3type from the SDL3 DATATYPES manual, and it is literally the blueprint for Condition effects. no cap.

---

✨ NAME ✨

SDL_HapticCondition — a structure containing a template for a Condition effect. she's a whole vibe and she's here to make your controller fight back. 🎀

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_haptic.h>

typedef struct SDL_HapticCondition
{
    /* Header */
    SDL_HapticEffectType type;      /**< SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER,
                                         SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION */
    SDL_HapticDirection direction;  /**< Direction of the effect. */

    /* Replay */
    Uint32 length;          /**< Duration of the effect. */
    Uint16 delay;           /**< Delay before starting the effect. */

    /* Trigger */
    Uint16 button;          /**< Button that triggers the effect. */
    Uint16 interval;        /**< How soon it can be triggered again after button. */

    /* Condition */
    Uint16 right_sat[3];    /**< Level when joystick is to the positive side; max 0xFFFF. */
    Uint16 left_sat[3];     /**< Level when joystick is to the negative side; max 0xFFFF. */
    Sint16 right_coeff[3];  /**< How fast to increase the force towards the positive side. */
    Sint16 left_coeff[3];   /**< How fast to increase the force towards the negative side. */
    Uint16 deadband[3];     /**< Size of the dead zone; max 0xFFFF: whole axis-range when 0-centered. */
    Sint16 center[3];       /**< Position of the dead zone. */
} SDL_HapticCondition;

look at her. so structured. so organized. main character energy fr fr 👑

---

🦋 DESCRIPTION 🦋

the struct handles the following effects:

• SDL_HAPTIC_SPRING: Effect based on axes position.
• SDL_HAPTIC_DAMPER: Effect based on axes velocity.
• SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
• SDL_HAPTIC_FRICTION: Effect based on axes movement.

okay so here's the tea about direction: it is handled by condition internals instead of a direction member. iykyk. 💅

the condition effect specific members have three parameters. the first refers to the X axis, the second refers to the Y axis and the third refers to the Z axis. (the way that's just three axes, periodt.)

the right terms refer to the positive side of the axis and the left terms refer to the negative side of the axis. please refer to the SDL_HapticDirection diagram for which side is positive and which is negative — that diagram is iconic and it will settle the debate for you. 🫶

---

⭐ AVAILABILITY ⭐

this struct is available since SDL 3.2.0. yes she's new, yes she ate. 🔥

---

🌈 SEE ALSO 🌈

• SDL_HapticDirection(3type)
• SDL_HAPTIC_SPRING(3)
• SDL_HAPTIC_DAMPER(3)
• SDL_HAPTIC_INERTIA(3)
• SDL_HAPTIC_FRICTION(3)
• SDL_HapticEffect(3type)

---

💀 friendly reminder: those [3] arrays are X, Y, Z in that exact order. don't be the person who mixes them up. not me doing a vibe check on your axis indices. 🙈

---

kisses bestie, that's the whole page!! 🍓🧚 mwah 💜

this was brought to you by Simple Directmedia Layer, version SDL 3.4.18, dated with all the love — and the page itself is, of course, SDL_HapticCondition(3type). go make something buzz. 💖✨🎀