Browse Source

Clarify that SDL_GetJoystickFromInstanceID() and SDL_GetGamepadFromInstanceID() return NULL if the associated device hasn't been opened yet.

Fixes https://github.com/libsdl-org/SDL/issues/7100
Sam Lantinga 2 năm trước cách đây
mục cha
commit
4becca4fc9
2 tập tin đã thay đổi với 4 bổ sung6 xóa
  1. 2 3
      include/SDL3/SDL_gamepad.h
  2. 2 3
      include/SDL3/SDL_joystick.h

+ 2 - 3
include/SDL3/SDL_gamepad.h

@@ -446,11 +446,10 @@ extern DECLSPEC char *SDLCALL SDL_GetGamepadInstanceMapping(SDL_JoystickID insta
 extern DECLSPEC SDL_Gamepad *SDLCALL SDL_OpenGamepad(SDL_JoystickID instance_id);
 
 /**
- * Get the SDL_Gamepad associated with a joystick instance ID.
+ * Get the SDL_Gamepad associated with a joystick instance ID, if it has been opened.
  *
  * \param instance_id the joystick instance ID of the gamepad
- * \returns an SDL_Gamepad on success or NULL on failure; call
- *          SDL_GetError() for more information.
+ * \returns an SDL_Gamepad on success or NULL on failure or if it hasn't been opened yet; call SDL_GetError() for more information.
  *
  * \since This function is available since SDL 3.0.0.
  */

+ 2 - 3
include/SDL3/SDL_joystick.h

@@ -283,11 +283,10 @@ extern DECLSPEC SDL_JoystickType SDLCALL SDL_GetJoystickInstanceType(SDL_Joystic
 extern DECLSPEC SDL_Joystick *SDLCALL SDL_OpenJoystick(SDL_JoystickID instance_id);
 
 /**
- * Get the SDL_Joystick associated with an instance ID.
+ * Get the SDL_Joystick associated with an instance ID, if it has been opened.
  *
  * \param instance_id the instance ID to get the SDL_Joystick for
- * \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError()
- *          for more information.
+ * \returns an SDL_Joystick on success or NULL on failure or if it hasn't been opened yet; call SDL_GetError() for more information.
  *
  * \since This function is available since SDL 3.0.0.
  */