SDL_RumbleJoystickTriggers(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💅 SDL_RumbleJoystickTriggers — SDL3 FUNCTIONS ✨

okay bestie, welcome to the manual page for SDL_RumbleJoystickTriggers, straight outta the SDL3 FUNCTIONS lineup 🎀

🌸 NAME 🌸

SDL_RumbleJoystickTriggers — start a rumble effect in the joystick's triggers, no cap 💥

✨ SYNOPSIS ✨

#include <SDL3/SDL_joystick.h>

bool SDL_RumbleJoystickTriggers(SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms);

🦋 DESCRIPTION 🦋

okay so here's the tea ☕ — every single call to this function cancels any previous trigger rumble effect, like it's not even being subtle about it. and if you call it with 0 intensity, it just stops any rumbling entirely. periodt. 🙅‍♀️

ngl, the important thing to clock here: this is rumbling of the _triggers_ and not the game controller as a whole. it's giving "very specific body part got the zoomies" energy. this is currently only supported on Xbox One controllers 👑 — so if you want the (more common) whole-controller rumble, use SDL_RumbleJoystick() instead. iykyk 💅

also, this function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state. like, it's not gonna just happen on its own, bestie, you gotta do the work 🫶

🎀 FUNCTION PARAMETERS 🎀

  • joystick — the joystick to vibrate. shake it, make it wiggle 💃
  • left_rumble — the intensity of the left trigger rumble motor, from 0 to 0xFFFF. so like, from "barely a whisper" to "full main character" 🔥
  • right_rumble — the intensity of the right trigger rumble motor, from 0 to 0xFFFF. same vibe, other side 🌈
  • duration_ms — the duration of the rumble effect, in milliseconds. how long the whole moment lasts ⏱️

⭐ RETURN VALUE ⭐

Returns true on success or false on failure. and if it fails?? call SDL_GetError() for more information — she'll tell you what went wrong 😭

🧚 THREAD SAFETY 🧚

It is safe to call this function from any thread. so go off, thread queen 👑✨

💜 AVAILABILITY 💜

This function is available since SDL 3.2.0. so if you're on something older... nope, not today 🙈

🌸 SEE ALSO 🌸

heads up bestie: this one's trigger-only and Xbox One-controller-only, so don't come for me when your whole controller isn't buzzing 🫠

and that's a wrap, mwah 💖 this page came from Simple Directmedia Layer, version SDL 3.4.18 — slay, bye, love u, drink water 🎀🦋✨

📦 where this page comes from