From deb0b3d693fbf6771030d0330fa85b9cc57a7bf0 Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Sun, 2 Dec 2012 21:00:15 +0100 Subject: [PATCH] Added more monitor API documentation. --- include/GL/glfw3.h | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/include/GL/glfw3.h b/include/GL/glfw3.h index d102d948..2f111a2d 100644 --- a/include/GL/glfw3.h +++ b/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