Update some window function documentation

Updates some documentation to correspond with changes made since it was originally written, clarifies some function behavior, and includes some assorted typo fixes.
This commit is contained in:
Frank Praznik
2024-10-08 12:26:35 -04:00
parent 300daf308a
commit 158ba93d61
2 changed files with 36 additions and 25 deletions

View File

@@ -133,7 +133,7 @@ typedef enum SDL_EventType
SDL_EVENT_WINDOW_ENTER_FULLSCREEN, /**< The window has entered fullscreen mode */
SDL_EVENT_WINDOW_LEAVE_FULLSCREEN, /**< The window has left fullscreen mode */
SDL_EVENT_WINDOW_DESTROYED, /**< The window with the associated ID is being or has been destroyed. If this message is being handled
in an event watcher, the window handle is still valid and can still be used to retrieve any userdata
in an event watcher, the window handle is still valid and can still be used to retrieve any properties
associated with the window. Otherwise, the handle has already been destroyed and all resources
associated with it are invalid */
SDL_EVENT_WINDOW_HDR_STATE_CHANGED, /**< Window HDR properties have changed */
@@ -554,7 +554,7 @@ typedef struct SDL_JoyDeviceEvent
} SDL_JoyDeviceEvent;
/**
* Joysick battery level change event structure (event.jbattery.*)
* Joystick battery level change event structure (event.jbattery.*)
*
* \since This struct is available since SDL 3.0.0.
*/