From 156aab2147afb798283d9bc030a6280b3cba9e15 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Fri, 16 Aug 2024 15:46:22 -0700 Subject: [PATCH] Added documentation for SDL_DisplayID and SDL_WindowID for consistency. --- include/SDL3/SDL_video.h | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h index 6fe65080a9..d9cf08fca6 100644 --- a/include/SDL3/SDL_video.h +++ b/include/SDL3/SDL_video.h @@ -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... */