OpenGL With Refpages

A GLEW extension that includes the Khronos OpenGL Reference Pages.

What is GLWR?

GLWR is an attempt to provide C/C++ header files for OpenGL functions that include relevant documentation about the functions of OpenGL. It uses GLEW to load the functions.

GLWR generates header files for each OpenGL Reference Page. It redefines the OpenGL functions with proper parameter names. For each function, it includes documentation in Doxygen format.

Building the GLWR headers

To build the GLWR headers and use them, you need:

• GLEW 2.1.0. If newer versions become available, GLWR will need to be tested for them.
• CMake 3.13 or higher
• ctre
• pugixml
• GCC 9+ with C++20 support

Build steps

• Clone the Git repository
  • git clone https://github.com/Rheel17/glwr.git
  • cd glwr
• Run CMake
  • mkdir build
  • cd build
  • cmake -DCMAKE_BUILD_TYPE=Release .. <options>
    Note: Building with -DCMAKE_BUILD_TYPE=Release will significantly reduce build times.
• Build
  • cmake --build .
    If this step fails due to an -fpermissive error in a RapidXml file, follow these steps.

The headers can now be found in /build/include/GL. Find your glew.h header file and copy glwr.h and func/*.h to the same directory. Alternatively, If you use makefiles as a CMake generator, run make install.

Options

Several options can be given in the CMake build step.

Include/exclude documentation sections

Use the following options to include/exclude documentation sections:

Option	Description	Default
-DLINK=<ON/OFF>	A link to the Khronos site	ON
-DBRIEF=<ON/OFF>	A short description about the function	ON
-DVERSION=<ON/OFF>	The OpenGL version where this function first appeared	ON
-DDESCRIPTION=<ON/OFF>	A long description about the function	OFF
-DEXAMPLES=<ON/OFF>	Examples on how to use the function	OFF
-DNOTES=<ON/OFF>	Notes about the function	OFF
-DPARAMETERS=<ON/OFF>	Information about the parameters	ON
-DERRORS=<ON/OFF>	Errors that the function can generate	ON
-DASSOCIATED_GETS=<ON/OFF>	Associated gets	OFF
-DSEE_ALSO=<ON/OFF>	A 'See Also' section	OFF
-DCOPYRIGHT=<ON/OFF>	A copyright notice	ON

Note that the documentation sections correspond to the sections in the OpenGL Refpages. Not all sections will be available for all functions.

Warning: enabling some sections (in particular the 'description' section) will result in some very large (>100kB) header files. Use with caution!

Verbose output

Enable verbose output using -DVERBOSE=ON. If VERBOSE is turned on, the generator code will output the header file names as they are generated.

Usage

Simply #include <GL/glwr.h> instead of GL/glew.h.

License/Copyright

The GLWR header generator source code is Copyright (c) 2022 Levi van Rheenen. It falls under the MIT license. See LICENSE.md for more information.

The generated header files fall under the licenses of their respective documentation. Go to the OpenGL Refpages repository for more information.