瀏覽代碼

Added documentation for SDL_DisplayID and SDL_WindowID for consistency.

Sam Lantinga 1 年之前
父節點
當前提交
156aab2147
共有 1 個文件被更改,包括 18 次插入1 次删除
  1. 18 1
      include/SDL3/SDL_video.h

+ 18 - 1
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... */