From c4abe0c3ed21c7b9e81fa1adf8ca766d6f4299c8 Mon Sep 17 00:00:00 2001 From: "A. Tombs" Date: Fri, 19 Jun 2020 01:14:41 +0100 Subject: [PATCH] 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. --- docs/window.dox | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/window.dox b/docs/window.dox index 2c5e95d6a..52a0e827c 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -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