SDL_SetHapticGain(3)

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

SDL_SetHapticGain(3) 💖

okay bestie, so this is a page from the SDL3 FUNCTIONS manual — that's the Simple Directmedia Layer crew, the legends who make games go brrr on every platform. and today's main character is a lil function called SDL_SetHapticGain. buckle up 🎀

✨ NAME ✨

SDL_SetHapticGain — set the global gain of the specified haptic device. that's it, that's the vibe. it turns the rumble dial on your controller/mouse/whatever-goes-bzzzz 💅

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_haptic.h>

bool SDL_SetHapticGain(SDL_Haptic *haptic, int gain);

look at that signature. clean. iconic. no notes. ✨

🦋 DESCRIPTION 🦋

okay so first things first, the device has to actually support the SDL_HAPTIC_GAIN feature, otherwise this whole thing is giving nothing. check that before you come crying to me 😭

here's the cute part: the user can specify the maximum gain by setting the environment variable SDL_HAPTIC_GAIN_MAX, which should be between 0 and 100. and then every single call to SDL_SetHapticGain() scales linearly using SDL_HAPTIC_GAIN_MAX as the maximum. so like, it's a ratio situation. math but make it vibes. 🧚

🎀 FUNCTION PARAMETERS 🎀

  • haptic — the SDL_Haptic device to set the gain on. your lil buzz-machine, basically 🫶
  • gain — value to set the gain to, should be between 0 and 100 (0 - 100). keep it in range, bestie, don't be chaotic 💀

⭐ RETURN VALUE ⭐

returns true on success or false on failure, and if it fails you gotta call SDL_GetError() for more information. she's not gonna explain herself unprompted, you have to ask 💅

🌈 AVAILABILITY 🌈

this function is available since SDL 3.2.0. so if you're on something ancient, no gain for you, sorry babe 🙈

👑 SEE ALSO 👑

lowkey reminder: the device must support SDL_HAPTIC_GAIN or this is all for nothing, and SDL_HAPTIC_GAIN_MAX wants to live between 0 and 100. iykyk 💜

and that's the whole page, bestie, periodt. brought to you by the Simple Directmedia Layer girlies, from SDL 3.4.18 of the SDL3 manual set, page SDL_SetHapticGain(3). now go make something buzz ✨💖🎀

📦 where this page comes from