From d946337724e47a7d122473749908e186d6d12f12 Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Tue, 27 Oct 2015 21:11:36 +0100 Subject: [PATCH] Document GLFW_CONTEXT_NO_ERROR caveat --- docs/window.dox | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/window.dox b/docs/window.dox index d934ecd9..b6a2d688 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -302,6 +302,14 @@ The no error mode for OpenGL and OpenGL ES is described in detail by the [GL_KHR_no_error](https://www.opengl.org/registry/specs/KHR/no_error.txt) extension. +@note This hint is experimental in its current state. There are currently +(October 2015) no corresponding WGL or GLX extensions. That makes this hint +a [hard constraint](@ref window_hints_hard) for those backends, as creation will +fail if unsupported context flags are requested. Once the extensions are +available, they will be required and creation of `GL_KHR_no_error` contexts may +fail on early drivers where this flag is supported without those extensions +being listed. + @subsubsection window_hints_values Supported and default values