mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-10 09:01:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work

Browse Source 
Most context related hint and attribute links had copypaste errors.
The GLFW_CONTEXT_RELEASE_BEHAVIOR and GLFW_CONTEXT_NO_ERROR attributes
did not have guide documentation.

(cherry picked from commit 3cf7645b96)
This commit is contained in:
Camilla Löwy 2019-05-19 21:41:57 +02:00
parent 9f5c6c6e89
commit 3afb2cc8ed
2 changed files with 35 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/window.dox
View File

@ -1332,6 +1332,21 @@ unknown or the context is an OpenGL ES context. Note that the returned profile
may not match the profile bits of the context flags, as GLFW will try other may not match the profile bits of the context flags, as GLFW will try other
means of detecting the profile when no bits are set. means of detecting the profile when no bits are set.
@anchor GLFW_CONTEXT_RELEASE_BEHAVIOR_attrib
__GLFW_CONTEXT_RELEASE_BEHAVIOR__ indicates the release used by the context.
Possible values are one of `GLFW_ANY_RELEASE_BEHAVIOR`,
`GLFW_RELEASE_BEHAVIOR_FLUSH` or `GLFW_RELEASE_BEHAVIOR_NONE`. If the
behavior is `GLFW_ANY_RELEASE_BEHAVIOR`, the default behavior of the context
creation API will be used. If the behavior is `GLFW_RELEASE_BEHAVIOR_FLUSH`,
the pipeline will be flushed whenever the context is released from being the
current one. If the behavior is `GLFW_RELEASE_BEHAVIOR_NONE`, the pipeline will
not be flushed on release.
@anchor GLFW_CONTEXT_NO_ERROR_attrib
__GLFW_CONTEXT_NO_ERROR__ indicates whether errors are generated by the context.
Possible values are `GLFW_TRUE` and `GLFW_FALSE`. If enabled, situations that
would have generated errors instead cause undefined behavior.
@anchor GLFW_CONTEXT_ROBUSTNESS_attrib @anchor GLFW_CONTEXT_ROBUSTNESS_attrib
__GLFW_CONTEXT_ROBUSTNESS__ indicates the robustness strategy used by the __GLFW_CONTEXT_ROBUSTNESS__ indicates the robustness strategy used by the
context. This is `GLFW_LOSE_CONTEXT_ON_RESET` or `GLFW_NO_RESET_NOTIFICATION` context. This is `GLFW_LOSE_CONTEXT_ON_RESET` or `GLFW_NO_RESET_NOTIFICATION`

40
include/GLFW/glfw3.h
View File

@ -917,62 +917,62 @@ extern "C" {
#define GLFW_CLIENT_API 0x00022001 #define GLFW_CLIENT_API 0x00022001
/*! @brief Context client API major version hint and attribute. /*! @brief Context client API major version hint and attribute.
* *
* Context client API major version [hint](@ref GLFW_CLIENT_API_hint) and * Context client API major version [hint](@ref GLFW_CONTEXT_VERSION_MAJOR_hint)
* [attribute](@ref GLFW_CLIENT_API_attrib). * and [attribute](@ref GLFW_CONTEXT_VERSION_MAJOR_attrib).
*/ */
#define GLFW_CONTEXT_VERSION_MAJOR 0x00022002 #define GLFW_CONTEXT_VERSION_MAJOR 0x00022002
/*! @brief Context client API minor version hint and attribute. /*! @brief Context client API minor version hint and attribute.
* *
* Context client API minor version [hint](@ref GLFW_CLIENT_API_hint) and * Context client API minor version [hint](@ref GLFW_CONTEXT_VERSION_MINOR_hint)
* [attribute](@ref GLFW_CLIENT_API_attrib). * and [attribute](@ref GLFW_CONTEXT_VERSION_MINOR_attrib).
*/ */
#define GLFW_CONTEXT_VERSION_MINOR 0x00022003 #define GLFW_CONTEXT_VERSION_MINOR 0x00022003
/*! @brief Context client API revision number hint and attribute. /*! @brief Context client API revision number hint and attribute.
* *
* Context client API revision number [hint](@ref GLFW_CLIENT_API_hint) and * Context client API revision number
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_CONTEXT_REVISION_attrib).
*/ */
#define GLFW_CONTEXT_REVISION 0x00022004 #define GLFW_CONTEXT_REVISION 0x00022004
/*! @brief Context robustness hint and attribute. /*! @brief Context robustness hint and attribute.
* *
* Context client API revision number [hint](@ref GLFW_CLIENT_API_hint) and * Context client API revision number [hint](@ref GLFW_CONTEXT_ROBUSTNESS_hint)
* [attribute](@ref GLFW_CLIENT_API_attrib). * and [attribute](@ref GLFW_CONTEXT_ROBUSTNESS_attrib).
*/ */
#define GLFW_CONTEXT_ROBUSTNESS 0x00022005 #define GLFW_CONTEXT_ROBUSTNESS 0x00022005
/*! @brief OpenGL forward-compatibility hint and attribute. /*! @brief OpenGL forward-compatibility hint and attribute.
* *
* OpenGL forward-compatibility [hint](@ref GLFW_CLIENT_API_hint) and * OpenGL forward-compatibility [hint](@ref GLFW_OPENGL_FORWARD_COMPAT_hint)
* [attribute](@ref GLFW_CLIENT_API_attrib). * and [attribute](@ref GLFW_OPENGL_FORWARD_COMPAT_attrib).
*/ */
#define GLFW_OPENGL_FORWARD_COMPAT 0x00022006 #define GLFW_OPENGL_FORWARD_COMPAT 0x00022006
/*! @brief OpenGL debug context hint and attribute. /*! @brief OpenGL debug context hint and attribute.
* *
* OpenGL debug context [hint](@ref GLFW_CLIENT_API_hint) and * OpenGL debug context [hint](@ref GLFW_OPENGL_DEBUG_CONTEXT_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_OPENGL_DEBUG_CONTEXT_attrib).
*/ */
#define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007 #define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007
/*! @brief OpenGL profile hint and attribute. /*! @brief OpenGL profile hint and attribute.
* *
* OpenGL profile [hint](@ref GLFW_CLIENT_API_hint) and * OpenGL profile [hint](@ref GLFW_OPENGL_PROFILE_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_OPENGL_PROFILE_attrib).
*/ */
#define GLFW_OPENGL_PROFILE 0x00022008 #define GLFW_OPENGL_PROFILE 0x00022008
/*! @brief Context flush-on-release hint and attribute. /*! @brief Context flush-on-release hint and attribute.
* *
* Context flush-on-release [hint](@ref GLFW_CLIENT_API_hint) and * Context flush-on-release [hint](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_attrib).
*/ */
#define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009 #define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009
/*! @brief Context error suppression hint and attribute. /*! @brief Context error suppression hint and attribute.
* *
* Context error suppression [hint](@ref GLFW_CLIENT_API_hint) and * Context error suppression [hint](@ref GLFW_CONTEXT_NO_ERROR_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_CONTEXT_NO_ERROR_attrib).
*/ */
#define GLFW_CONTEXT_NO_ERROR 0x0002200A #define GLFW_CONTEXT_NO_ERROR 0x0002200A
/*! @brief Context creation API hint and attribute. /*! @brief Context creation API hint and attribute.
* *
* Context creation API [hint](@ref GLFW_CLIENT_API_hint) and * Context creation API [hint](@ref GLFW_CONTEXT_CREATION_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_CONTEXT_CREATION_API_attrib).
*/ */
#define GLFW_CONTEXT_CREATION_API 0x0002200B #define GLFW_CONTEXT_CREATION_API 0x0002200B
/*! @brief Window content area scaling window /*! @brief Window content area scaling window