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-04-01 21:00:26 +00:00
parent 8847b35244
commit 18c8af6e48
3 changed files with 25 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/SDL3/SDL_gamepad.h
View File

@@ -845,7 +845,9 @@ extern DECLSPEC Uint64 SDLCALL SDL_GetGamepadSteamHandle(SDL_Gamepad *gamepad);
* Get the connection state of a gamepad. * Get the connection state of a gamepad.
* *
* \param gamepad the gamepad object to query. * \param gamepad the gamepad object to query.
* \returns the connection state on success or `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError() for more information. * \returns the connection state on success or
* `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError()
* for more information.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
*/ */
@@ -861,7 +863,10 @@ extern DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetGamepadConnectionStat
* reports, or completely drain when reporting it has 20 percent left, etc. * reports, or completely drain when reporting it has 20 percent left, etc.
* *
* \param gamepad the gamepad object to query. * \param gamepad the gamepad object to query.
* \param percent a pointer filled in with the percentage of battery life left, between 0 and 100, or NULL to ignore. This will be filled in with -1 we can't determine a value or there is no battery. * \param percent a pointer filled in with the percentage of battery life
* left, between 0 and 100, or NULL to ignore. This will be
* filled in with -1 we can't determine a value or there is no
* battery.
* \returns the current battery state. * \returns the current battery state.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.

12
include/SDL3/SDL_joystick.h
View File

@@ -1083,7 +1083,9 @@ extern DECLSPEC void SDLCALL SDL_CloseJoystick(SDL_Joystick *joystick);
* Get the connection state of a joystick. * Get the connection state of a joystick.
* *
* \param joystick The joystick to query * \param joystick The joystick to query
* \returns the connection state on success or `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError() for more information. * \returns the connection state on success or
* `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError()
* for more information.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
*/ */
@@ -1099,8 +1101,12 @@ extern DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetJoystickConnectionSta
* reports, or completely drain when reporting it has 20 percent left, etc. * reports, or completely drain when reporting it has 20 percent left, etc.
* *
* \param joystick The joystick to query * \param joystick The joystick to query
* \param percent a pointer filled in with the percentage of battery life left, between 0 and 100, or NULL to ignore. This will be filled in with -1 we can't determine a value or there is no battery. * \param percent a pointer filled in with the percentage of battery life
* \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure; call SDL_GetError() for more information. * left, between 0 and 100, or NULL to ignore. This will be
* filled in with -1 we can't determine a value or there is no
* battery.
* \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure;
* call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
*/ */

12
include/SDL3/SDL_power.h
View File

@@ -65,9 +65,15 @@ typedef enum
* It's possible a platform can only report battery percentage or time left * It's possible a platform can only report battery percentage or time left
* but not both. * but not both.
* *
* \param seconds a pointer filled in with the seconds of battery life left, or NULL to ignore. This will be filled in with -1 if we can't determine a value or there is no battery. * \param seconds a pointer filled in with the seconds of battery life left,
* \param percent a pointer filled in with the percentage of battery life left, between 0 and 100, or NULL to ignore. This will be filled in with -1 we can't determine a value or there is no battery. * or NULL to ignore. This will be filled in with -1 if we
* \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure; call SDL_GetError() for more information. * can't determine a value or there is no battery.
* \param percent a pointer filled in with the percentage of battery life
* left, between 0 and 100, or NULL to ignore. This will be
* filled in with -1 we can't determine a value or there is no
* battery.
* \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure;
* call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
*/ */