Added more monitor API documentation.

This commit is contained in:
Camilla Berglund 2012-12-02 21:00:15 +01:00
parent 73cdc34df7
commit deb0b3d693

View File

@ -683,13 +683,39 @@ extern "C" {
*/ */
#define GLFW_GAMMA_RAMP_SIZE 256 #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 #define GLFW_MONITOR_PHYSICAL_WIDTH 0x00060001
/*! @brief The physical height, in mm, of the monitor.
* @ingroup monitor
*/
#define GLFW_MONITOR_PHYSICAL_HEIGHT 0x00060002 #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 #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 #define GLFW_MONITOR_POS_Y 0x00060004
/* @} */
/*! @name Monitor events
* @{ */
/*! @brief The monitor was connected.
* @ingroup monitor
*/
#define GLFW_MONITOR_CONNECTED 0x00061000 #define GLFW_MONITOR_CONNECTED 0x00061000
/*! @brief The monitor was disconnected.
* @ingroup monitor
*/
#define GLFW_MONITOR_DISCONNECTED 0x00061001 #define GLFW_MONITOR_DISCONNECTED 0x00061001
/* @} */
/************************************************************************* /*************************************************************************
* Typedefs * Typedefs