https://github.com/challanger524/chernoopengl-cmake
Cross-platform restoration of TheCherno OpenGL YouTube series with perfect commit history (link to YouTube OpenGL playlist by The Cherno below)
https://github.com/challanger524/chernoopengl-cmake
cherno cmake cpp cpp17 graphics-programming graphics2d imgui learning lessons opengl perfect-commits perfect-history rebase-warning thecherno
Last synced: about 1 month ago
JSON representation
Cross-platform restoration of TheCherno OpenGL YouTube series with perfect commit history (link to YouTube OpenGL playlist by The Cherno below)
- Host: GitHub
- URL: https://github.com/challanger524/chernoopengl-cmake
- Owner: Challanger524
- License: unlicense
- Created: 2022-06-24T12:10:33.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T23:03:19.000Z (4 months ago)
- Last Synced: 2025-03-27T02:11:25.605Z (about 2 months ago)
- Topics: cherno, cmake, cpp, cpp17, graphics-programming, graphics2d, imgui, learning, lessons, opengl, perfect-commits, perfect-history, rebase-warning, thecherno
- Language: C++
- Homepage: https://www.youtube.com/playlist?list=PLlrATfBNZ98foTJPJ_Ev03o2oq3-GGOS2
- Size: 438 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# ChernoOpenGL-CMake
**CMake**-based implementation of TheCherno's [OpenGL series](https://www.youtube.com/playlist?list=PLlrATfBNZ98foTJPJ_Ev03o2oq3-GGOS2) with minimal code deviance according to videos.
## Features
- **C++ 17**
- **CMake** - cross-platform build system
- cross-platform dependencies handling
- tested on:
- Windows 10 - `Visual Studio 2022`, `VS Code v1.86`: `MSVC` 19.34, `Clang` 17.0.4, `GCC` 13.2 (Rev2, Built by MSYS2 project)
- Linux Mint 20 - `VS Code v1.75`: `GCC` 9.4, `Clang` 10.0
- MacOS (Mac Mini M2) - `VS Code`: `GCC`, `Apple-Clang`
- **perfect commits** - reached through git-history rewriting
- pros: clean diffs between commits (best for learn-repositories)
- pros: no typo/logic fixing or improving separate commits
- cons: unstable (ever changing) commit _hashes_ and _timestamps_
- commands:
- `rebase -i ~`/`rebase -i --root`; (then follow `status` hints)
- `git rm ` # the only way to change submodule \ field
- `git filter-repo --refs --replace-text <(echo 'regex:Dependencies/==>deps/')`
- `git filter-repo --refs --replace-text <(echo 'regex:^\xEF\xBB\xBF==>')` # strip BOM
- see [doc/note.sh](doc/note.sh) for other commands and use cases
- **git submodules** - each dependency present as a submodule
- much clear dependency-introduction commits
- up-to-date source of dependencies' repositories
- no need for additional downloads during the install stage
### Differences
- **header-only** due to my laziness :) - more compact codebase :+1:
- **error-logging** - debug output with `GL_KHR_debug`:`glDebugMessageCallback()` (if possible):
- debugging stuff moved from `Renderer.hpp` to new `Utility.hpp`
- detailed GPU-vendor error description with **debug output**:
- can be implemented in OpenGL versions prior to 4.3 (by GPU-vendor)
- worked on OpenGL 4.0 (Intel CPU) (on old tiny laptop)
- **imgui docking** branch - allows moving imgui-windows outside and to dock them to each other
- **batch rendering** episodes - adopted with last 4 commits
- The Cherno explained with non-related source code (repository)
- some **stl::type_traits** related bragging :sunglasses: (`Utility.hpp`: `GLASSERT()` macro)
### Debatable
- headers-definitions (without sources), single `.cpp` file with `int main()`
- maybe allows to switch easier to the `C++20 modules`
> All _concerns_ can be expressed via GitHub [Project's Issues](https://github.com/Challanger524/ChernoOpenGL-CMake/issues) (one issue per concern)
## Clone
``` shell
git clone --recurse --shallow-submodules "https://github.com/Challanger524/ChernoOpenGL-CMake.git"
```
## Prerequisites
- **CMake** - cross-platform build automation system
- (for minimal version see [CMakeLists.txt#L1](CMakeLists.txt#L1))
- **Ninja** - small build system with a focus on speed
- **C++ compiler** (any): MSVC / GCC / Clang
- on GNU Linux:
- install dev libs listed below and/or google CMake log for other required
- `sudo apt-get install`: `libxi-dev libxrandr-dev libxcursor-dev libxinerama-dev libopengl-dev`
## Build
Visual Studio
Official documentation: [CMake projects in Visual Studio](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-170&viewFallbackFrom=vs-2019)
> `C++ CMake tools for Windows` module must be installed (see docs [Installation](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-170#installation) part)
0. open the project folder with _Visual Studio_ (and enable CMake via dialog prompt, if any)
0. in the upper toolbar choose `MSVC` configuration
0. Project->Configure ChernoOpenGL
0. Build->Build All
0. set `CMakeLists.txt` as _Startup Item_ via _Solution Explorer_ (or see [Debugging CMake projects](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-170#debugging-cmake-projects) part)
0. Debug->Start Debugging
VS Code
Official documentation: [Get started with CMake Tools on Linux](https://code.visualstudio.com/docs/cpp/cmake-linux) (less suitable article then as for Visual Studio)
> 1.`C/C++` and 2.`CMake Tools` extensions (by Microsoft) must be installed (see docs [Prerequisites](https://code.visualstudio.com/docs/cpp/cmake-linux#_prerequisites) part)
Note: on Windows...
when building with `msvc` preset, to rid off unconfigured preset messages - you need to [run VS Code from a Developer Command Prompt for Visual Studio](
https://code.visualstudio.com/docs/cpp/config-msvc#_check-your-microsoft-visual-c-installation:~:text=To%20use%20MSVC%20from%20a%20command%20line%20or%20VS%20Code%2C%20you%20must%20run%20from%20a%20Developer%20Command%20Prompt%20for%20Visual%20Studio)
I created a _shorcut_ to launch VS Code with next `Target`:
```
%comspec% /C "C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\Tools\VsDevCmd.bat" & code
```
> with `/C` option it should close itself automatically, but sometimes it is not - so just close it manually after VS Code launched.
0. open the project folder
0. configure from preset via dialog (CMake) prompt, or:
- select preset - open Command Palette (`Ctrl+Shift+P`) and type `CMake: Select Configure Preset` then choose suitable
- configure - open Command Palette (`Ctrl+Shift+P`) and type `CMake: Configure` (if not started automatically)
0. build - open Command Palette (`Ctrl+Shift+P`) and type `CMake: Build `(or press a _build_ (:radio_button:) button in the bottom toolbar)
0. run:
- debug - open Command Palette (`Ctrl+Shift+P`) and type `CMake: Debug ` (or press `F5`) (or press a _debug_ :bug: (near :arrow_forward:) in the bottom toolbar)
- launch (if debug is unavailable) - `Menu Bar->Run->Run Without Debugging` (or `Ctrl+F5`) (or :arrow_forward: button in the bottom toolbar)
Command Line
> Presets were introduced in `CMake 3.19`
0. `cmake --list-presets`
0. `cmake --preset `
0. `ninja -C out/build/`
0. `./ChernoOpenGL` (or `./ChernoOpenGL.exe` on _shWindows_)
## Showcase
#### Console output examples:
MS Windows 10 (NVIDIA GTX 1060)
```
Info: Context: Debug - active (supported)
Info: GL: Extension: GL_KHR_debug - OK
Info: GLFW version: 3.4.0 Win32 WGL Null EGL OSMesa MinGW-w64
Info: GLEW version: 2.2.0
Info: GL version: 3.3.0 NVIDIA 537.34
Info: GLSL version: 3.30 NVIDIA via Cg compiler
Info: GPU vendor : NVIDIA Corporation
Info: Renderer : NVIDIA GeForce GTX 1060 3GB/PCIe/SSE2
Info: ImGui version: 1.90.4 +docking +viewport
Trace: Registering test: Clear Color
Trace: Registering test: Texture 2D
Trace: Registering test: Batching
Trace: Registering test: Batching Textures
Trace: Registering test: Batching Textures (dynamic)
```
Apple Mac Mini M2
```
Info: Context: Debug - inactive (or unsupported)
Info: GLFW version: 3.4.0 Cocoa NSGL Null EGL OSMesa monotonic
Info: GLEW version: 2.2.0
Info: GL version: 4.1 Metal - 88
Info: GLSL version: 4.10
Info: GPU vendor : Apple
Info: Renderer : Apple M2
Info: ImGui version: 1.90.4 +docking +viewport
Trace: Registering test: Clear Color
Trace: Registering test: Texture 2D
Trace: Registering test: Batching
Trace: Registering test: Batching Textures
```
#### Screenshots:
Test Menu
Clear Color
Texture 2D
Batching
Batching Textures
Batching Textures (dynamic)
### Moral Ownership
- `Cherno` `Hazel` logos and `Educational aspect` of the source code - belongs to **Yan Chernikov** [TheCherno](https://github.com/TheCherno) the way YouTube [OpenGL series](https://www.youtube.com/playlist?list=PLlrATfBNZ98foTJPJ_Ev03o2oq3-GGOS2) does
- `restoration` `polishing` `fixing` `(over)correcting` `(for_perfectiest_solution) researhing` `(folder) structuring/renaming` `dependency managing` `perfect git-history keeping` `doc/ -umenting` `CMake -ing` `readme.md composing` `.editorconfig -ing` `.gitignore -ing` `cross-platform -ing` _`codestyling`_ - was done (outprocrastinated and overthinked) by **Daniil Semenenko** [Challanger524](https://github.com/Challanger524)
- other `tools` `sources` `materials` are not hided or appropriated (at least not intentionally) and are provided with `links` to the original `sources` whenever possible
- additional thanks to **speauty**'s [ChernoOpenGL](https://github.com/speauty/ChernoOpenGL) implementation for working and mostly accurate code, that was used as a reference for clarification of certain moments and typos, that greatly saved some of my time.
### Changelog: [doc/changelog.md](doc/changelog.md)
### Misc
- It took a bit more than a month to finish this project and half a day to port on Linux (and a week to polish all warnings and complete documentation)
- And it took years to polish it all 😐🚬
- This project helped me to cure 👨⚕️ my 👩💻`git-` and `cmake-anxiety` ;)
- Cherno is the only and the best C++ teacher, see also his [C++ playlist](https://www.youtube.com/playlist?list=PLlrATfBNZ98dudnM48yfGUldqGD0S4FFb).
- Motto: "in case of anything - stay ironically-cynic and/or cynically-ironic `¯\_(ツ)_/¯`🃏"