docs: Explain events for already plugged in controllers (#11286)

This commit is contained in:
Jordan Christiansen
2024-10-21 13:06:05 -05:00
committed by GitHub
parent 26567df878
commit 9c848e08e4
2 changed files with 33 additions and 0 deletions

View File

@@ -549,7 +549,12 @@ typedef struct SDL_JoyButtonEvent
/**
* Joystick device event structure (event.jdevice.*)
*
* SDL will send JOYSTICK_ADDED events for devices that
* are already plugged in during SDL_Init.
*
* \since This struct is available since SDL 3.0.0.
*
* \sa SDL_GamepadDeviceEvent
*/
typedef struct SDL_JoyDeviceEvent
{
@@ -615,7 +620,15 @@ typedef struct SDL_GamepadButtonEvent
/**
* Gamepad device event structure (event.gdevice.*)
*
* Joysticks that are supported gamepads receive both an SDL_JoyDeviceEvent and
* an SDL_GamepadDeviceEvent.
*
* SDL will send GAMEPAD_ADDED events for joysticks
* that are already plugged in during SDL_Init() and are recognized as gamepads. It will also send events for joysticks that get gamepad mappings at runtime.
*
* \since This struct is available since SDL 3.0.0.
*
* \sa SDL_JoyDeviceEvent
*/
typedef struct SDL_GamepadDeviceEvent
{