https://github.com/capnramses/antons_opengl_tutorials_book
Anton's OpenGL 4 Tutorials book - Demo Code
https://github.com/capnramses/antons_opengl_tutorials_book
computer-graphics examples opengl
Last synced: 25 days ago
JSON representation
Anton's OpenGL 4 Tutorials book - Demo Code
- Host: GitHub
- URL: https://github.com/capnramses/antons_opengl_tutorials_book
- Owner: capnramses
- License: other
- Created: 2014-07-31T11:23:41.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T20:30:49.000Z (7 months ago)
- Last Synced: 2025-04-02T20:36:40.238Z (7 months ago)
- Topics: computer-graphics, examples, opengl
- Language: C++
- Homepage: http://antongerdelan.net/opengl/
- Size: 51.4 MB
- Stars: 990
- Watchers: 56
- Forks: 282
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- AwesomeCppGameDev - antons_opengl_tutorials_book - Demo Code (Graphics)
README
# Anton's OpenGL 4 Tutorials book demo code
> [!NOTE]\
> This series of demos accompanies the e-book "Anton's OpenGL 4 Tutorials":
> [antongerdelan.net/opengl](http://antongerdelan.net/opengl/)
## Table of Contents
1. [Info](#info)
2. [Compiling on Linux](#compiling-on-linux)
2. [Compiling on macOS](#compiling-on-macos)
3. [Compiling on Windows with Visual Studio](#compiling-on-windows-with-visual-studio)
4. [Compiling on Windows with GCC](#compiling-on-windows-with-gcc)
5. [Contribution and Contributors](#contribution-and-contributors)
6. [Licence](#licence)
## Info
Each chapter with major demonstration code has a corresponding demo here.
There is also an example of code for *Hello Triangle* for OpenGL 2.1 for reference.
Each demo has easy-to-read Makefiles for Linux, macOS, and Windows.
You may need to download newer versions of the libraries in the `third_party/` folder.
This code is some years old now and builds may fall out of date.
I try to maintain this so that it functions, but be aware that Makefiles and
build details may differ slightly from book text for this reason.
## Compiling on Linux
* Install a C and C++ compiler - usually by installing a `build-essential`
bundle package via the package manager on your distribution. E.g. for Ubuntu:
```shell
sudo apt install build-essential
```
* Install the GLEW, GLFW3, FreeType, and Assimp development libraries. E.g. for Ubuntu:
```shell
sudo apt install libglew-dev libglfw3-dev libfreetype-dev libassimp-dev
```
* Open a terminal and `cd` to the demo of choice, then:
```shell
make -f Makefile.linux64
```
* Or, to build all the demos at once, you can run `./build_all_linux_macos.sh` from the main directory.
## Compiling on macOS
* Install the Clang or GNU compiler and tools. Usually this is done by installing Apple [XCode](https://apps.apple.com/us/app/xcode/id497799835?mt=12) through the App Store.
* You will probably wish to install libraries _via_ the [Homebrew](https://brew.sh/) package manager:
```shell
brew install glew glfw assimp freetype
```
* Open a terminal and `cd` to the demo of choice:
```shell
make -f Makefile.osx
```
* Or, to build all the demos at once, you can run `./build_all_linux_macos.sh` from the main directory.
## Compiling on Windows with Visual Studio
Install Microsoft Visual Studio. Any edition is fine. There are several alternatives to compile with Visual Studio:
* Using the included batch files.
* Installing libraries with NuGet within Visual Studio.
* Installing libraries manually within Visual Studio.
> [!NOTE]\
> Compiling using a batch file is an easy option for working with Visual Studio's compiler.
> It's also an easier way to build all the demos in one go, if you just want to try them all first.
> The only catch is editing the batch file to get the correct path to your compiler tools.
### Batch Files
For your convenience a `build.bat` file is included in each demo. These will use Visual Studio's command-line tools to
compile the demo:
1. Open the `build.bat` file in a text editor.
2. Check that the path to your edition of Visual Studio's tools matches your installed copy.
3. Run the batch file by double-clicking on it, or from the command line.
If you want to build all the demos in one go, there is a file called `build_all_msvc.bat`.
You will also need to check the Visual Studio tool path at the top of this file.
### Within Visual Studio
Create a new _Empty_, _C++_, _Console_ project.
You can then easily install the required libraries with _NuGet_, under the _Project_ menu of a new C++ project, and you're ready to draw a triangle in 5 minutes.
##### Install Libraries with NuGet
1. In the _Browse_ tab search for and install; `glfw`, and `glew`. For later tutorials you can also find `assimp`, and `freetype`, when required.
2. You need to add the text `opengl32.lib` to your linker input string. You can find this in _Project->Properties->Configuration Properties->Linker->Input->Additional Dependencies_. Just add `opengl32.lib;` to the front of the long string of dependencies so that it changes to `opengl32.lib;kernel32.lib;user32;...`.
3. You do not need to add the libraries you installed _via_ NuGet to the linker string.
4. You can now compile a _Hello Triangle_ demo for OpenGL using GLFW and GLEW.
##### Install Libraries Manually
If you would rather do things the old fashioned way, without using a package manager, I have recorded a 2020 video stream tutorial where I show how to get Visual Studio set up and start programming OpenGL, including downloading and setting up libraries.
[Tutorial: Intro to 3D Graphics Programming with OpenGL 4 (with Anton). Stream Recording.](https://youtu.be/qQJ7irgxZFQ)
This includes a very verbose set-up of Visual Studio 2019 with helper libraries.
## Compiling on Windows with GCC
* Install the GNU Compiler Collection - usually by installing MinGW. I suggest the minimal MinGW GCC distribution at [https://nuwen.net/mingw.html](https://nuwen.net/mingw.html).
* Open a console and `cd` to the demo of choice.
* `make -f Makefile.win64`
There is also a `build_all_mingw.bat` file in the main directory, that you can run to build all of the demos with GCC.
If you have trouble linking supporting libraries you may need to download and recompile GLFW, GLEW, AssImp, and FreeType. It's a good idea to do this anyway to stay up to date.
* https://www.glfw.org/
* https://glew.sourceforge.net/
* https://freetype.org/download.html
* https://github.com/assimp/assimp
## Caveats and Errata
* Since publication the most reliable version of newer OpenGL that will work everywhere, including macOS, is 4.1 Core. I suggest setting _window hints_ to try this version first. See the updated [Hello Triangle](https://antongerdelan.net/opengl/hellotriangle.html) for an example.
* Code is directly copy-pasted from book sections. This means that there will be redundant OpenGL calls to bind things etc., but I think it's easier to follow along like this.
* Code explained in prior examples is moved to a file called `gl_utils.cpp` to avoid cluttering `main.cpp`. This means that `gl_utils.cpp` is not necessarily the same in each demo, but is built up gradually.
* Out-of-date build files have been removed; 32-bit builds, and older Visual Studio files.
* Sometimes people ask for C examples. OpenGL is a C API, and I would have used C if writing the text later. Readers wishing to use a C compiler should do so - only very minor code convention changes are required.
## Contribution and Contributors
If you find a bug please feel encouraged to create an Issue, or make a Pull Request, bearing in mind the _Caveats_ above.
Build systems and Visual Studio solution files will not be included, to keep things simple.
Special thanks to all the readers over the years that have submitted additions,
bug reports, fixes, and feedback. If you have submitted a correction and don't
mind having your name/@ printed here please let me know (or if you'd like to change these details).
* Olivier Nivoix
* Sarang Baheti
* kevin
* Jon
* Julien Castelain
* Benjamin Summerton
* Fwjrei
* guysherman
* 24kwakahana
* battila7
* Gnimuc
* Peter Getek
* Mikel Losada
* Kevin Moran
* Jon
* Pablo Alonso-Villaverde Roza
## Licence
See [LICENCE.md](LICENCE.md) for licence and copyright information.