eden-emu/SDL
19
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

wikiheaders: Updated to latest, cleaned up category documentation a little.

Browse source 
This documentation needs a LOT of work--maybe someday--but it's definitely not
_broken_ right now, which is good enough for now.
This commit is contained in:
Ryan C. Gordon 2024-05-16 11:41:54 -04:00
parent 96e3799495
commit 1c3a1e1139
No known key found for this signature in database
GPG key ID: FA148B892AB48044
55 changed files with 499 additions and 380 deletions
Download patch file Download diff file Expand all files Collapse all files

28
include/SDL_haptic.h
View file

@ -20,23 +20,23 @@
*/
/**
* \file SDL_haptic.h
* # CategoryHaptic
*
* \brief The SDL haptic subsystem allows you to control haptic (force feedback)
* devices.
* SDL haptic subsystem allows you to control haptic (force feedback) devices.
*
* The basic usage is as follows:
* - Initialize the subsystem (SDL_INIT_HAPTIC).
* - Open a haptic device.
* - SDL_HapticOpen() to open from index.
* - SDL_HapticOpenFromJoystick() to open from an existing joystick.
* - Create an effect (SDL_HapticEffect).
* - Upload the effect with SDL_HapticNewEffect().
* - Run the effect with SDL_HapticRunEffect().
* - (optional) Free the effect with SDL_HapticDestroyEffect().
* - Close the haptic device with SDL_HapticClose().
* The basic usage is as follows:
*
* \par Simple rumble example:
* - Initialize the subsystem (SDL_INIT_HAPTIC).
* - Open a haptic device.
* - SDL_HapticOpen() to open from index.
* - SDL_HapticOpenFromJoystick() to open from an existing joystick.
* - Create an effect (SDL_HapticEffect).
* - Upload the effect with SDL_HapticNewEffect().
* - Run the effect with SDL_HapticRunEffect().
* - (optional) Free the effect with SDL_HapticDestroyEffect().
* - Close the haptic device with SDL_HapticClose().
*
* Simple rumble example:
*
* ```c
* SDL_Haptic *haptic;