From 8a69a0d7e545a88de3dd88710e4a881932ca07ed Mon Sep 17 00:00:00 2001 From: "A. Tombs" Date: Thu, 18 Jun 2020 02:23:08 +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. Closes #1720. --- docs/window.dox | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/window.dox b/docs/window.dox index 868c6c21..52a0e827 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -406,10 +406,14 @@ 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 -functionality. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. If OpenGL ES -is requested, this hint is ignored. +__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