gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Added a note about virtual joysticks to CategoryJoystick.

Browse Source 
Fixes https://github.com/libsdl-org/sdlwiki/issues/78
This commit is contained in:
Ryan C. Gordon
2025-07-30 00:42:57 -04:00
parent c663b6ec1f
commit ea04bdb5f3
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
include/SDL3/SDL_joystick.h
View File

@@ -29,8 +29,8 @@
* instead. * instead.
* *
* The term "instance_id" is the current instantiation of a joystick device in * The term "instance_id" is the current instantiation of a joystick device in
* the system, if the joystick is removed and then re-inserted then it will * the system. If the joystick is removed and then re-inserted then it will
* get a new instance_id, instance_id's are monotonically increasing * get a new instance_id. instance_id's are monotonically increasing
* identifiers of a joystick plugged in. * identifiers of a joystick plugged in.
* *
* The term "player_index" is the number assigned to a player on a specific * The term "player_index" is the number assigned to a player on a specific
@@ -48,6 +48,14 @@
* If you would like to receive joystick updates while the application is in * If you would like to receive joystick updates while the application is in
* the background, you should set the following hint before calling * the background, you should set the following hint before calling
* SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS * SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
*
* SDL can provide virtual joysticks as well: the app defines an imaginary
* controller with SDL_AttachVirtualJoystick(), and then can provide inputs
* for it via SDL_SetJoystickVirtualAxis(), SDL_SetJoystickVirtualButton(),
* etc. As this data is supplied, it will look like a normal joystick to SDL,
* just not backed by a hardware driver. This has been used to make unusual
* devices, like VR headset controllers, look like normal joysticks, or
* provide recording/playback of game inputs, etc.
*/ */
#ifndef SDL_joystick_h_ #ifndef SDL_joystick_h_