Browse Source

Sync SDL3 wiki -> header

SDL Wiki Bot 1 year ago
parent
commit
5e96e410d6
2 changed files with 16 additions and 12 deletions
  1. 8 6
      include/SDL3/SDL_gamepad.h
  2. 8 6
      include/SDL3/SDL_joystick.h

+ 8 - 6
include/SDL3/SDL_gamepad.h

@@ -594,12 +594,14 @@ extern DECLSPEC SDL_Gamepad *SDLCALL SDL_GetGamepadFromPlayerIndex(int player_in
  *
  * These properties are shared with the underlying joystick object.
  *
- * The following read-only properties are provided by SDL:
- * - `SDL_PROP_GAMEPAD_CAP_MONO_LED_BOOLEAN`: true if this gamepad has an LED that has adjustable brightness
- * - `SDL_PROP_GAMEPAD_CAP_RGB_LED_BOOLEAN`: true if this gamepad has an LED that has adjustable color
- * - `SDL_PROP_GAMEPAD_CAP_PLAYER_LED_BOOLEAN`: true if this gamepad has a player LED
- * - `SDL_PROP_GAMEPAD_CAP_RUMBLE_BOOLEAN`: true if this gamepad has left/right rumble
- * - `SDL_PROP_GAMEPAD_CAP_TRIGGER_RUMBLE_BOOLEAN`: true if this gamepad has simple trigger rumble
+ * The following read-only properties are provided by SDL: -
+ * `SDL_PROP_GAMEPAD_CAP_MONO_LED_BOOLEAN`: true if this gamepad has an LED
+ * that has adjustable brightness - `SDL_PROP_GAMEPAD_CAP_RGB_LED_BOOLEAN`:
+ * true if this gamepad has an LED that has adjustable color -
+ * `SDL_PROP_GAMEPAD_CAP_PLAYER_LED_BOOLEAN`: true if this gamepad has a
+ * player LED - `SDL_PROP_GAMEPAD_CAP_RUMBLE_BOOLEAN`: true if this gamepad
+ * has left/right rumble - `SDL_PROP_GAMEPAD_CAP_TRIGGER_RUMBLE_BOOLEAN`: true
+ * if this gamepad has simple trigger rumble
  *
  * \param gamepad a gamepad identifier previously returned by
  *                SDL_OpenGamepad()

+ 8 - 6
include/SDL3/SDL_joystick.h

@@ -460,12 +460,14 @@ extern DECLSPEC int SDLCALL SDL_SetJoystickVirtualHat(SDL_Joystick *joystick, in
 /**
  * Get the properties associated with a joystick.
  *
- * The following read-only properties are provided by SDL:
- * - `SDL_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN`: true if this joystick has an LED that has adjustable brightness
- * - `SDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN`: true if this joystick has an LED that has adjustable color
- * - `SDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN`: true if this joystick has a player LED
- * - `SDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN`: true if this joystick has left/right rumble
- * - `SDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN`: true if this joystick has simple trigger rumble
+ * The following read-only properties are provided by SDL: -
+ * `SDL_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN`: true if this joystick has an LED
+ * that has adjustable brightness - `SDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN`:
+ * true if this joystick has an LED that has adjustable color -
+ * `SDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN`: true if this joystick has a
+ * player LED - `SDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN`: true if this joystick
+ * has left/right rumble - `SDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN`:
+ * true if this joystick has simple trigger rumble
  *
  * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick()
  * \returns a valid property ID on success or 0 on failure; call