Clarify docs on default GL header inclusion

The documentation claims that any extension loader library header
included before the GLFW one will prevent the inclusion of the
default OpenGL header.  In reality this only worked if the loader
defined the canonical desktop OpenGL __gl_h_ inclusion guard and even
then relied on the OpenGL header to detect this.

This is the companion to 105cf32e0b, which
added the preprocessor logic to check for many known OpenGL and OpenGL
ES inclusion guards and not even attempt to include the default header
if any are present.

Some clarification of the language around header inclusion has also been
attempted, including making GLFW_INCLUDE_NONE more prominent.

Fixes #1695.

(cherry picked from commit 399c2a1fad)
This commit is contained in:
Camilla Löwy
2020-05-28 17:38:21 +02:00
parent e336288eeb
commit 63af05c419
3 changed files with 47 additions and 43 deletions
+2
View File
@@ -118,6 +118,8 @@ information on what to include when reporting a bug.
## Changelog
- Bugfix: Some extension loader headers did not prevent default OpenGL header
inclusion (#1695)
- [Cocoa] Use `CALayer` instead of `NSView` for `EGLNativeWindowType` (#1169)
- [X11] Bugfix: IME input of CJK was broken for "C" locale (#1587,#1636)
- [X11] Bugfix: Xlib errors caused by other parts of the application could be