瀏覽代碼

Clarified device ID documentation

Fixes https://github.com/libsdl-org/SDL/issues/10558
Sam Lantinga 11 月之前
父節點
當前提交
cb85894e94

+ 1 - 2
include/SDL3/SDL_camera.h

@@ -48,8 +48,7 @@ extern "C" {
  *
  * 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
- * invalid ID.
+ * The value 0 is an invalid ID.
  *
  * \since This datatype is available since SDL 3.0.0.
  *

+ 1 - 2
include/SDL3/SDL_haptic.h

@@ -919,8 +919,7 @@ typedef union SDL_HapticEffect
  *
  * 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
- * invalid ID.
+ * The value 0 is an invalid ID.
  *
  * \since This datatype is available since SDL 3.0.0.
  */

+ 1 - 2
include/SDL3/SDL_joystick.h

@@ -91,8 +91,7 @@ typedef struct SDL_Joystick SDL_Joystick;
  *
  * 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
- * invalid ID.
+ * The value 0 is an invalid ID.
  *
  * \since This datatype is available since SDL 3.0.0.
  */

+ 1 - 2
include/SDL3/SDL_keyboard.h

@@ -45,8 +45,7 @@ extern "C" {
  *
  * 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
- * invalid ID.
+ * The value 0 is an invalid ID.
  *
  * \since This datatype is available since SDL 3.0.0.
  */

+ 18 - 1
include/SDL3/SDL_mouse.h

@@ -38,9 +38,26 @@
 extern "C" {
 #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 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().

+ 1 - 2
include/SDL3/SDL_sensor.h

@@ -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
  * 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
- * invalid ID.
+ * The value 0 is an invalid ID.
  *
  * \since This datatype is available since SDL 3.0.0.
  */