mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-22 04:54:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work

Browse Source 
[ci skip]
This commit is contained in:
Camilla Löwy 2016-12-08 17:08:36 +01:00
parent 58ceab5f1e
commit 831426ca63
1 changed files with 62 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
include/GLFW/glfw3.h
View File

@ -647,37 +647,37 @@ extern "C" {
#define GLFW_ICONIFIED 0x00020002 #define GLFW_ICONIFIED 0x00020002
/*! @brief Window resize-ability window hint and attribute /*! @brief Window resize-ability window hint and attribute
* *
* Window resize-ability [window hint](@ref GLFW_RESIZABLE_hint) or * Window resize-ability [window hint](@ref GLFW_RESIZABLE_hint) and
* [window attribute](@ref GLFW_RESIZABLE_attrib). * [window attribute](@ref GLFW_RESIZABLE_attrib).
*/ */
#define GLFW_RESIZABLE 0x00020003 #define GLFW_RESIZABLE 0x00020003
/*! @brief Window visibility window hint and attribute /*! @brief Window visibility window hint and attribute
* *
* Window visibility [window hint](@ref GLFW_VISIBLE_hint) or * Window visibility [window hint](@ref GLFW_VISIBLE_hint) and
* [window attribute](@ref GLFW_VISIBLE_attrib). * [window attribute](@ref GLFW_VISIBLE_attrib).
*/ */
#define GLFW_VISIBLE 0x00020004 #define GLFW_VISIBLE 0x00020004
/*! @brief Window decoration window hint and attribute /*! @brief Window decoration window hint and attribute
* *
* Window decoration [window hint](@ref GLFW_DECORATED_hint) or * Window decoration [window hint](@ref GLFW_DECORATED_hint) and
* [window attribute](@ref GLFW_DECORATED_attrib). * [window attribute](@ref GLFW_DECORATED_attrib).
*/ */
#define GLFW_DECORATED 0x00020005 #define GLFW_DECORATED 0x00020005
/*! @brief Window auto-iconification window hint and attribute /*! @brief Window auto-iconification window hint and attribute
* *
* Window auto-iconification [window hint](@ref GLFW_AUTO_ICONIFY_hint) or * Window auto-iconification [window hint](@ref GLFW_AUTO_ICONIFY_hint) and
* [window attribute](@ref GLFW_AUTO_ICONIFY_attrib). * [window attribute](@ref GLFW_AUTO_ICONIFY_attrib).
*/ */
#define GLFW_AUTO_ICONIFY 0x00020006 #define GLFW_AUTO_ICONIFY 0x00020006
/*! @brief Window decoration window hint and attribute /*! @brief Window decoration window hint and attribute
* *
* Window decoration [window hint](@ref GLFW_FLOATING_hint) or * Window decoration [window hint](@ref GLFW_FLOATING_hint) and
* [window attribute](@ref GLFW_FLOATING_attrib). * [window attribute](@ref GLFW_FLOATING_attrib).
*/ */
#define GLFW_FLOATING 0x00020007 #define GLFW_FLOATING 0x00020007
/*! @brief Window maximization window hint and attribute /*! @brief Window maximization window hint and attribute
* *
* Window maximization [window hint](@ref GLFW_MAXIMIZED_hint) or * Window maximization [window hint](@ref GLFW_MAXIMIZED_hint) and
* [window attribute](@ref GLFW_MAXIMIZED_attrib). * [window attribute](@ref GLFW_MAXIMIZED_attrib).
*/ */
#define GLFW_MAXIMIZED 0x00020008 #define GLFW_MAXIMIZED 0x00020008
@ -762,21 +762,75 @@ extern "C" {
* Framebuffer double buffering [hint](@ref GLFW_DOUBLEBUFFER). * Framebuffer double buffering [hint](@ref GLFW_DOUBLEBUFFER).
*/ */
#define GLFW_DOUBLEBUFFER 0x00021010 #define GLFW_DOUBLEBUFFER 0x00021010
/*! @} */ /*! @brief Context client API hint and attribute.
*
* Context client API [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_CLIENT_API 0x00022001 #define GLFW_CLIENT_API 0x00022001
/*! @brief Context client API major version hint and attribute.
*
* Context client API major version [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_CONTEXT_VERSION_MAJOR 0x00022002 #define GLFW_CONTEXT_VERSION_MAJOR 0x00022002
/*! @brief Context client API minor version hint and attribute.
*
* Context client API minor version [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_CONTEXT_VERSION_MINOR 0x00022003 #define GLFW_CONTEXT_VERSION_MINOR 0x00022003
/*! @brief Context client API revision number hint and attribute.
*
* Context client API revision number [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_CONTEXT_REVISION 0x00022004 #define GLFW_CONTEXT_REVISION 0x00022004
/*! @brief Context robustness hint and attribute.
*
* Context client API revision number [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_CONTEXT_ROBUSTNESS 0x00022005 #define GLFW_CONTEXT_ROBUSTNESS 0x00022005
/*! @brief OpenGL forward-compatibility hint and attribute.
*
* OpenGL forward-compatibility [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_OPENGL_FORWARD_COMPAT 0x00022006 #define GLFW_OPENGL_FORWARD_COMPAT 0x00022006
/*! @brief OpenGL debug context hint and attribute.
*
* OpenGL debug context [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007 #define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007
/*! @brief OpenGL profile hint and attribute.
*
* OpenGL profile [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_OPENGL_PROFILE 0x00022008 #define GLFW_OPENGL_PROFILE 0x00022008
/*! @brief Context flush-on-release hint and attribute.
*
* Context flush-on-release [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009 #define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009
/*! @brief Context error suppression hint and attribute.
*
* Context error suppression [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_CONTEXT_NO_ERROR 0x0002200A #define GLFW_CONTEXT_NO_ERROR 0x0002200A
/*! @brief Context creation API hint and attribute.
*
* Context creation API [hint](@ref GLFW_CLIENT_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib).
*/
#define GLFW_CONTEXT_CREATION_API 0x0002200B #define GLFW_CONTEXT_CREATION_API 0x0002200B
#define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001 #define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001
/*! @} */
#define GLFW_NO_API 0 #define GLFW_NO_API 0
#define GLFW_OPENGL_API 0x00030001 #define GLFW_OPENGL_API 0x00030001