Browse Source

Added more monitor API documentation.

Camilla Berglund 12 năm trước cách đây
mục cha
commit
deb0b3d693
1 tập tin đã thay đổi với 27 bổ sung1 xóa
  1. 27 1
      include/GL/glfw3.h

+ 27 - 1
include/GL/glfw3.h

@@ -683,13 +683,39 @@ extern "C" {
  */
 #define GLFW_GAMMA_RAMP_SIZE      256
 
-/* Monitor constants */
+/*! @name Monitor parameters
+ *  @{ */
+/*! @brief The physical width, in mm, of the monitor.
+ *  @ingroup monitor
+ */
 #define GLFW_MONITOR_PHYSICAL_WIDTH  0x00060001
+/*! @brief The physical height, in mm, of the monitor.
+ *  @ingroup monitor
+ */
 #define GLFW_MONITOR_PHYSICAL_HEIGHT 0x00060002
+/*! @brief The x-coordinate of the upper-left corner of the monitor on the
+ *  virtual desktop.
+ *  @ingroup monitor
+ */
 #define GLFW_MONITOR_POS_X           0x00060003
+/*! @brief The y-coordinate of the upper-left corner of the monitor on the
+ *  virtual desktop.
+ *  @ingroup monitor
+ */
 #define GLFW_MONITOR_POS_Y           0x00060004
+/* @} */
+
+/*! @name Monitor events
+ *  @{ */
+/*! @brief The monitor was connected.
+ *  @ingroup monitor
+ */
 #define GLFW_MONITOR_CONNECTED       0x00061000
+/*! @brief The monitor was disconnected.
+ *  @ingroup monitor
+ */
 #define GLFW_MONITOR_DISCONNECTED    0x00061001
+/* @} */
 
 /*************************************************************************
  * Typedefs