Browse Source

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

Sam Lantinga 2 years ago
parent
commit
aad2df7f0d
2 changed files with 2 additions and 2 deletions
  1. 1 1
      include/SDL_gamecontroller.h
  2. 1 1
      include/SDL_joystick.h

+ 1 - 1
include/SDL_gamecontroller.h

@@ -455,7 +455,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetPlayerIndex(SDL_GameController
  * Set the player index of an opened game controller.
  *
  * \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.
  */

+ 1 - 1
include/SDL_joystick.h

@@ -514,7 +514,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick *joystick);
  * Set the player index of an opened joystick.
  *
  * \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.
  */