SDL_StopHapticEffect(3)

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

💅 SDL_StopHapticEffect — the SDL3 functions girlies

okay bestie, welcome to the manual page for SDL_StopHapticEffect, straight out of the SDL3 FUNCTIONS section 🎀

✨ NAME ✨

SDL_StopHapticEffect — stop the haptic effect on its associated haptic device. that's it, that's the job 💖

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_haptic.h>

bool SDL_StopHapticEffect(SDL_Haptic *haptic, SDL_HapticEffectID effect);

🦋 FUNCTION PARAMETERS 🦋

  • haptic — the SDL_Haptic device to stop the effect on. like, which controller/rumbly thing are we talking to 🫶
  • effect — the ID of the haptic effect to stop. yes, the actual ID, not the vibe, not the concept, the ID ✨

⭐ RETURN VALUE ⭐

returns true on success or false on failure — and if it's giving failure, call SDL_GetError() for more information, because she will tell you what went wrong 💀

🌈 AVAILABILITY 🌈

this function is available since SDL 3.2.0. no cap, it's not in the old ones 🧚

💜 SEE ALSO 💜

iykyk — one stops one effect, the other stops all of them, pick your fighter 👑

lowkey important: this stops the effect, so if you wanted the rumble to keep going, bestie, that's a different function 😭

Simple Directmedia Layer wrote this, it's version SDL 3.4.18, and it's the SDL_StopHapticEffect(3) page. mwah, go stop some effects, you main character 🎀💅✨

📦 where this page comes from