Document passing -1 to clear the player index for a controller

main
Sam Lantinga 2022-08-09 08:47:49 -07:00
parent 8695d982d2
commit aad2df7f0d
2 changed files with 2 additions and 2 deletions

View File

@ -455,7 +455,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetPlayerIndex(SDL_GameController
* Set the player index of an opened game controller. * Set the player index of an opened game controller.
* *
* \param gamecontroller the game controller object to adjust. * \param gamecontroller the game controller object to adjust.
* \param player_index Player index to assign to this controller. * \param player_index Player index to assign to this controller, or -1 to clear the player index and turn off player LEDs.
* *
* \since This function is available since SDL 2.0.12. * \since This function is available since SDL 2.0.12.
*/ */

View File

@ -514,7 +514,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick *joystick);
* Set the player index of an opened joystick. * Set the player index of an opened joystick.
* *
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen() * \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
* \param player_index the player index to set. * \param player_index Player index to assign to this joystick, or -1 to clear the player index and turn off player LEDs.
* *
* \since This function is available since SDL 2.0.12. * \since This function is available since SDL 2.0.12.
*/ */