Added documentation for SDL_DisplayID and SDL_WindowID for consistency.

This commit is contained in:
Sam Lantinga 2024-08-16 15:46:22 -07:00
parent 4fbdbbbde6
commit 156aab2147
1 changed files with 18 additions and 1 deletions

View File

@ -41,8 +41,25 @@
extern "C" {
#endif
/**
* This is a unique ID for a display for the time it is connected to the
* system, and is never reused for the lifetime of the application.
*
* If the display is disconnected and reconnected, it will get a new ID.
*
* The value 0 is an invalid ID.
*
* \since This datatype is available since SDL 3.0.0.
*/
typedef Uint32 SDL_DisplayID;
/**
* This is a unique ID for a window.
*
* The value 0 is an invalid ID.
*
* \since This datatype is available since SDL 3.0.0.
*/
typedef Uint32 SDL_WindowID;
/* Global video properties... */