Re-word docs for OPENGL_DEBUG_CONTEXT hint

Re-worded documentation for the `GLFW_OPENGL_DEBUG_CONTEXT` window hint to avoid implying that it only applies to OpenGL contexts. Added a link to the relevant Khronos extension description.
This commit is contained in:
A. Tombs 2020-06-19 01:14:41 +01:00 committed by GitHub
parent f72cc5db10
commit c4abe0c3ed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -406,10 +406,15 @@ Forward-compatibility is described in detail in the
[OpenGL Reference Manual](https://www.opengl.org/registry/).
@anchor GLFW_OPENGL_DEBUG_CONTEXT_hint
__GLFW_OPENGL_DEBUG_CONTEXT__ specifies whether to create a debug OpenGL
context, which may have additional error and performance issue reporting
__GLFW_OPENGL_DEBUG_CONTEXT__ specifies whether the context should be created
in debug mode, which may provide additional error and diagnostic reporting
functionality. Possible values are `GLFW_TRUE` and `GLFW_FALSE`.
@par
Debug contexts for OpenGL and OpenGL ES are described in detail by the
[GL_KHR_debug](https://www.khronos.org/registry/OpenGL/extensions/KHR/KHR_debug.txt)
extension.
@anchor GLFW_OPENGL_PROFILE_hint
__GLFW_OPENGL_PROFILE__ specifies which OpenGL profile to create the context
for. Possible values are one of `GLFW_OPENGL_CORE_PROFILE` or