mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-26 12:27:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2024-01-27 23:12:19 +00:00
parent f66fe7e221
commit 5e96e410d6
2 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
include/SDL3/SDL_gamepad.h
View File

@@ -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()

14
include/SDL3/SDL_joystick.h
View File

@@ -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