Forráskód Böngészése

Sync SDL3 wiki -> header

SDL Wiki Bot 1 éve
szülő
commit
18c8af6e48
3 módosított fájl, 25 hozzáadás és 8 törlés
  1. 7 2
      include/SDL3/SDL_gamepad.h
  2. 9 3
      include/SDL3/SDL_joystick.h
  3. 9 3
      include/SDL3/SDL_power.h

+ 7 - 2
include/SDL3/SDL_gamepad.h

@@ -845,7 +845,9 @@ extern DECLSPEC Uint64 SDLCALL SDL_GetGamepadSteamHandle(SDL_Gamepad *gamepad);
  * Get the connection state of a gamepad.
  *
  * \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.
  */
@@ -861,7 +863,10 @@ extern DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetGamepadConnectionStat
  * reports, or completely drain when reporting it has 20 percent left, etc.
  *
  * \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.
  *
  * \since This function is available since SDL 3.0.0.

+ 9 - 3
include/SDL3/SDL_joystick.h

@@ -1083,7 +1083,9 @@ extern DECLSPEC void SDLCALL SDL_CloseJoystick(SDL_Joystick *joystick);
  * Get the connection state of a joystick.
  *
  * \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.
  */
@@ -1099,8 +1101,12 @@ extern DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetJoystickConnectionSta
  * reports, or completely drain when reporting it has 20 percent left, etc.
  *
  * \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.
- * \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure; call SDL_GetError() for more information.
+ * \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.
  */

+ 9 - 3
include/SDL3/SDL_power.h

@@ -65,9 +65,15 @@ typedef enum
  * It's possible a platform can only report battery percentage or time left
  * 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 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.
+ * \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 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.
  */