eden-emu/SDL
14
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-15 17:28:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Clarified device ID documentation

Browse source 
Fixes https://github.com/libsdl-org/SDL/issues/10558
This commit is contained in:
Sam Lantinga 2024-08-16 15:20:11 -07:00
parent 7d78835f87
commit cb85894e94
6 changed files with 23 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

3
include/SDL3/SDL_camera.h
View file

@ -48,8 +48,7 @@ extern "C" {
* *
* If the device is disconnected and reconnected, it will get a new ID. * If the device is disconnected and reconnected, it will get a new ID.
* *
* The ID value starts at 1 and increments from there. The value 0 is an * The value 0 is an invalid ID.
* invalid ID.
* *
* \since This datatype is available since SDL 3.0.0. * \since This datatype is available since SDL 3.0.0.
* *

3
include/SDL3/SDL_haptic.h
View file

@ -919,8 +919,7 @@ typedef union SDL_HapticEffect
* *
* If the haptic device is disconnected and reconnected, it will get a new ID. * If the haptic device is disconnected and reconnected, it will get a new ID.
* *
* The ID value starts at 1 and increments from there. The value 0 is an * The value 0 is an invalid ID.
* invalid ID.
* *
* \since This datatype is available since SDL 3.0.0. * \since This datatype is available since SDL 3.0.0.
*/ */

3
include/SDL3/SDL_joystick.h
View file

@ -91,8 +91,7 @@ typedef struct SDL_Joystick SDL_Joystick;
* *
* If the joystick is disconnected and reconnected, it will get a new ID. * If the joystick is disconnected and reconnected, it will get a new ID.
* *
* The ID value starts at 1 and increments from there. The value 0 is an * The value 0 is an invalid ID.
* invalid ID.
* *
* \since This datatype is available since SDL 3.0.0. * \since This datatype is available since SDL 3.0.0.
*/ */

3
include/SDL3/SDL_keyboard.h
View file

@ -45,8 +45,7 @@ extern "C" {
* *
* If the keyboard is disconnected and reconnected, it will get a new ID. * If the keyboard is disconnected and reconnected, it will get a new ID.
* *
* The ID value starts at 1 and increments from there. The value 0 is an * The value 0 is an invalid ID.
* invalid ID.
* *
* \since This datatype is available since SDL 3.0.0. * \since This datatype is available since SDL 3.0.0.
*/ */

19
include/SDL3/SDL_mouse.h
View file

@ -38,9 +38,26 @@
extern "C" { extern "C" {
#endif #endif
/**
* This is a unique ID for a mouse for the time it is connected to the
* system, and is never reused for the lifetime of the application.
*
* If the mouse is disconnected and reconnected, it will get a new ID.
*
* The value 0 is an invalid ID.
*
* \since This datatype is available since SDL 3.0.0.
*/
typedef Uint32 SDL_MouseID; typedef Uint32 SDL_MouseID;
typedef struct SDL_Cursor SDL_Cursor; /**< Implementation dependent */ /**
* The structure used to identify an SDL cursor.
*
* This is opaque data.
*
* \since This struct is available since SDL 3.0.0.
*/
typedef struct SDL_Cursor SDL_Cursor;
/** /**
* Cursor types for SDL_CreateSystemCursor(). * Cursor types for SDL_CreateSystemCursor().

3
include/SDL3/SDL_sensor.h
View file

@ -55,8 +55,7 @@ typedef struct SDL_Sensor SDL_Sensor;
* This is a unique ID for a sensor for the time it is connected to the * This is a unique ID for a sensor for the time it is connected to the
* system, and is never reused for the lifetime of the application. * system, and is never reused for the lifetime of the application.
* *
* The ID value starts at 1 and increments from there. The value 0 is an * The value 0 is an invalid ID.
* invalid ID.
* *
* \since This datatype is available since SDL 3.0.0. * \since This datatype is available since SDL 3.0.0.
*/ */