Skip to content

Single file header OpenGL documentation for IDE code completion

License

Notifications You must be signed in to change notification settings

DaveH355/opengl-doc-wrapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 

Repository files navigation

opengl-doc-wrapper

A single file header that wraps glad with OpenGL docs. It's based on OpenGL 4.5 from docs.gl. Most functions are covered but some might be missing. Extensions are not included.

Motivation

Not all IDEs are able to give code completion for OpenGL functions loaded by glad. This is not good, especially if you are a beginner like me. Here's an example of what might happen with neovim + clangd image

With the documentation wrapper, it can give better info image

Usage

Get started by downloading the desired header for C or C++ from this project's include folder. You can use the header alongside glad. You can remove it later without affecting your code.

#include <glad/glad.h>
#include "gldoc.h"

or use it in place of glad

#include "gldoc.h"

About

Single file header OpenGL documentation for IDE code completion

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published