OpenGL Loading Library

From OpenGL Wiki
Jump to navigation Jump to search

An OpenGL Loading Library is a library that loads pointers to OpenGL functions at runtime, core as well as extensions. This is required to access functions from OpenGL versions above 1.1 on most platforms. Extension loading libraries also abstracts away the difference between the loading mechanisms on different platforms.

Most extension loading libraries override the need to include gl.h at all. Instead, they provide their own header that must be used. Most extension loading libraries use code generation to construct the code that loads the function pointers and the included headers. Information is available if you wish to perform this manually, but you are encouraged to use one of these libraries yourself.

GLEW (OpenGL Extension Wrangler)[edit]

The OpenGL Extension Wrangler library provides access to all GL entrypoints. It supports Windows, MacOS X, Linux, and FreeBSD.

As with most other loaders, you should not include gl.h, glext.h, or any other gl related header file before glew.h, otherwise you'll get an error message that you have included gl.h before glew.h. In fact, you shouldn't be including gl.h at all; glew.h replaces it.

GLEW also provides wglew.h which provides Windows specific GL functions (wgl functions). If you include wglext.h before wglew.h, GLEW will complain. GLEW also provides glxew.h for X windows systems. If you include glxext.h before glxew.h, GLEW will complain.

The latest release as of June 2021 is version 2.2.0.

Initialization of GLEW 1.13.0 and earlier[edit]

GLEW up to version 1.13.0 has a problem with core contexts. It calls glGetString(GL_EXTENSIONS), which causes GL_INVALID_ENUM on GL 3.2+ core context as soon as glewInit() is called. It also doesn't fetch the function pointers. GLEW version 2.0.0+ uses glGetStringi instead. The only fix for earlier versions is to use glewExperimental:

  // If using GLEW version 1.13 or earlier
  glewExperimental=TRUE;
  GLenum err=glewInit();
  if(err!=GLEW_OK) {
    // Problem: glewInit failed, something is seriously wrong.
    cout << "glewInit failed: " << glewGetErrorString(err) << endl;
    exit(1);
  }

glewExperimental is a variable that is already defined by GLEW. You must set it to GL_TRUE before calling glewInit().

You might still get GL_INVALID_ENUM (depending on the version of GLEW you use), but at least GLEW ignores glGetString(GL_EXTENSIONS) and gets all function pointers.

If you are creating a GL context the old way or if you are creating a backward compatible context for GL 3.2+, then you don't need glewExperimental.

GL3W[edit]

The GL3W library focuses on the core profile of OpenGL 3 and 4. It only loads the core entrypoints for these OpenGL versions. It supports Windows, Mac OS X, Linux, and FreeBSD.

Note: GL3W loads core OpenGL only by default. All OpenGL extensions will be loaded if the --ext flag is specified to gl3w_gen.py.

GL3W relies on a Python script for its code generation. Unlike other extension loaders, GL3W actually does the code generation on your machine. This is based on downloading and parsing the glcorearb.h file from the OpenGL Registry website.

On the one hand, this means that it is always up-to-date. On the other hand, this also makes it beholden to the format of glcorearb.h (which has no true format), as well as requiring that the user of GL3W have a Python installation.

GL3W is used like this:

#include <GL/gl3w.h>
#include <GLFW/glfw3.h>

int main() {
  if (!glfwInit()) {
    printf("failed to initialize GLFW.\n");
    return -1;
  }

  glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
  glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
  glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);

  auto window = glfwCreateWindow(1000, 600, "awesome", nullptr, nullptr);
  if (!window) {
    return -1;
  }

  glfwMakeContextCurrent(window);
  if (gl3wInit()) {
    printf("failed to initialize OpenGL\n");
    return -1;
  }

  printf("OpenGL %s, GLSL %s\n", glGetString(GL_VERSION), glGetString(GL_SHADING_LANGUAGE_VERSION));

  // ...

  return 0;
}

Galogen[edit]

Galogen is a GL loader generator in the spirit of glLoadGen, but with no additional dependencies (like Lua). Given an API version and a list of extensions, Galogen will produce corresponding headers and code that load the exact OpenGL entry points you need. The produced code can then be used directly by your C or C++ application, without having to link against any additional libraries. Galogen uses the official Khronos OpenGL Registry as its source of truth, thus ensuring that the produced code always corresponds to the latest specifications. An in-browser version of Galogen is also available.

glad (Multi-Language GL/GLES/EGL/GLX/WGL Loader-Generator)[edit]

Glad is pretty similiar to glLoadGen, it generates a loader for your exact needs based on the official specifications from the Khronos SVN. This means they are always up to date! It was written in a way that you can easily extend it to other languages (e.g. at the date of writing this there are 4 different code generating backends).

You can use the glad website to generate a loader for your needs, download it and use it in your project. Another method of using glad is cloning/downloading the repository and generating your own loader. The tool itself is pretty easy to use and works with any Python version above 2.6, you can also include the source directly into your CMake project.

Glad gives you the option to also generate a very basic loader (similiar to gl3w or glxw), but it is recommended to use the loading function provided by your context creation framework, like glfwGetProcAddress. Here is how it looks:

// glad, include glad *before* glfw
#include <glad/glad.h>
// GLFW
#include <GLFW/glfw3.h>

// ... <snip> ...

int main()
{
    // Init GLFW
    glfwInit();
    // ... <snip> ... setup a window and a context
 
    // Load all OpenGL functions using the glfw loader function
    // If you use SDL you can use: https://wiki.libsdl.org/SDL_GL_GetProcAddress
    if (!gladLoadGLLoader((GLADloadproc) glfwGetProcAddress)) {
        std::cout << "Failed to initialize OpenGL context" << std::endl;
        return -1;
    }
    // Alternative use the builtin loader, e.g. if no other loader function is available
    /*
    if (!gladLoadGL()) {
        std::cout << "Failed to initialize OpenGL context" << std::endl;
        return -1;
    }
    */
  
    // glad populates global constants after loading to indicate,
    // if a certain extension/version is available.
    printf("OpenGL %d.%d\n", GLVersion.major, GLVersion.minor);

    if(GLAD_GL_EXT_framebuffer_multisample) {
        /* GL_EXT_framebuffer_multisample is supported */ 
    }
    if(GLAD_GL_VERSION_3_0) {
        /* We support at least OpenGL version 3 */
    }

    // ... <snip> ... more code
}

Glad is able to generate a debugging header, which allows you to hook into your OpenGL calls really easily using glad_set_pre_callback and glad_set_post_callback, you can find a more detailed guide on the github repository.

Glatter[edit]

Glatter is a generated library, with support for GL, GLES, GLU, EGL, GLX, WGL.

Its usage requires the inclusion of one header:

#include <glatter.h>

In C++ code, it may as well be used as header-only.

It requires no explicit loading or initialization calls, and its startup cost is minimal.

Besides loading, it offers debugging and tracing functionality.

More details can be found on its github page.

glsdk (Unofficial OpenGL SDK)[edit]

The Unofficial OpenGL SDK includes a component for loading OpenGL functions. This component, called GL Load, has a C and C++ interface for loading OpenGL functions. It also provides different headers for different OpenGL versions. It even has headers that remove compatibility enums and functions for versions of OpenGL 3.1 or greater.

Here is a code example:

#include <glload/gl_3_3.h> //OpenGL version 3.3, core profile. C-style functions.
#include <glload/gll.h>    //The C-style loading interface.

//Include headers for FreeGLUT/GLFW/other GL tools.

int main(int argc, char *argv[])
{
  //Initialize OpenGL and bind the context
  
  if(LoadFunctions() == LS_LOAD_FAILED)
    //exit in some way
        
  //Loading succeeded. Now use OpenGL functions.
  
  //Do OpenGL stuff.
  GLuint vertShader = glCreateShader(GL_VERTEX_SHADER);
  GLuint fragShader = glCreateShader(GL_FRAGMENT_SHADER);
  ...
}

GL Load even offers special headers for C++ code, that moves as much of OpenGL as possible into a namespace. The equivalent code in the C++ interface is as follows:

#include <glload/gl_3_3.hpp> //OpenGL version 3.3, core profile. C++-style functions.
#include <glload/gll.hpp>    //The C-style loading interface.

//Include headers for FreeGLUT/GLFW/other GL tools.

int main(int argc, char *argv[])
{
  //Initialize OpenGL and bind the context
  
  if(glload::LoadFunctions() == glload::LS_LOAD_FAILED)
    //exit in some way
        
  //Loading succeeded. Now use OpenGL functions.
  
  //Do OpenGL stuff.
  GLuint vertShader = gl::CreateShader(gl::GL_VERTEX_SHADER);
  GLuint fragShader = gl::CreateShader(gl::GL_FRAGMENT_SHADER);
  ...
}

glbinding (C++)[edit]

glbinding is a new, generated, cross-platform C++ binding for OpenGL which is solely based on the new xml-based OpenGL API specification (gl.xml). It leverages modern C++11 features like enum classes, lambdas, and variadic templates, instead of relying on macros (all OpenGL symbols are real functions and variables). It provides type-safe parameters, per feature API header, lazy function resolution, multi-context and multi-thread support, global function callbacks, meta information about the generated OpenGL binding and the OpenGL runtime, as well as multiple examples for quick-starting your projects.

Current gl code, written with a typical C binding for OpenGL is fully compatible for the use with glbinding:

#include <glbinding/gl/gl.h>
#include <glbinding/Binding.h>

using namespace gl;

int main()
{
  // create context, e.g. using GLFW, Qt, SDL, GLUT, ...

  glbinding::Binding::initialize();

  glBegin(GL_TRIANGLES);
  // ...
  glEnd();
}

glbinding also supports OpenGL feature (version) specific symbols for functions, enums, and bitfields. For example:

  • functions32.h provides all OpenGL commands available up to 3.2 in namespace gl32.
  • functions32core.h provides all non-deprecated OpenGL commands available up to 3.2 in namespace gl32core.
  • functions32ext.h provides all OpenGL commands specified either in 3.3 and above, or by extension in gl32ext.

More details and examples can be found on the github project page and examples wiki respectively.

libepoxy[edit]

libepoxy requires no initialization code. The only thing you have to do is:

#include <epoxy/gl.h>
#include <epoxy/glx.h>

GLee[edit]

The project seems more or less defunct.

While there is activity in the Git repository on Sourceforge, there has not been a new official version and distribution in years. The recent activity could represent a project coming back, but currently you would be better advised to look elsewhere for an OpenGL loader.