gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

include: A ton of little documentation tweaks, fixes, and improvements.

Browse Source 
This is just stuff I noticed while working on the wikiheaders updates. A
thorough pass over all the docs would not be terrible, and maybe a simple
script to check for consistency (does everything have a `\since` on it? etc)
might be nice, too.
This commit is contained in:
Ryan C. Gordon
2024-04-08 22:36:57 -04:00
parent 645073961d
commit ad090d2444
45 changed files with 1565 additions and 833 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
include/SDL3/SDL_events.h
View File

@@ -54,7 +54,7 @@ extern "C" {
/**
* The types of events that can be delivered.
*/
typedef enum
typedef enum SDL_EventType
{
SDL_EVENT_FIRST = 0, /**< Unused (do not remove) */
@@ -671,10 +671,10 @@ typedef struct SDL_PenButtonEvent
} SDL_PenButtonEvent;
/**
* An event used to drop text or request a file open by the system (event.drop.*)
* An event used to drop text or request a file open by the system (event.drop.*)
*
* The `data` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event.
* The `data` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event. Do not free it!
*/
typedef struct SDL_DropEvent
{
@@ -722,7 +722,13 @@ typedef struct SDL_QuitEvent
} SDL_QuitEvent;
/**
* A user-defined event type (event.user.*)
* A user-defined event type (event.user.*)
*
* This event is unique; it is never created by SDL, but only by the
* application. The event can be pushed onto the event queue using
* SDL_PushEvent(). The contents of the structure members are completely
* up to the programmer; the only requirement is that '''type''' is a value
* obtained from SDL_RegisterEvents().
*/
typedef struct SDL_UserEvent
{
@@ -737,7 +743,7 @@ typedef struct SDL_UserEvent
/**
* General event structure
* The structure for all events in SDL.
*/
typedef union SDL_Event
{
@@ -823,7 +829,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_Event, sizeof(SDL_Event) == sizeof(((SDL_Event *)NUL
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
/* @{ */
typedef enum
typedef enum SDL_eventaction
{
SDL_ADDEVENT,
SDL_PEEKEVENT,
@@ -1263,7 +1269,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_EventEnabled(Uint32 type);
extern DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
/**
* Allocate dynamic memory for an SDL event
* Allocate dynamic memory for an SDL event.
*
* You can use this to allocate memory for user events that will be
* automatically freed after the event is processed.