⚪ OpenGL Seed

• 🐟 Glitch Example

• 💬 Blog Post

A starter repo that you could use to build an OpenGL application on top of.

Check out the this blog post for more details about this example.

Setup

First install:

• Git

• CMake

• An IDE such as Visual Studio, XCode, or a compiler such as GCC.

Then type the following in your terminal.

# 🐑 Clone the repo
git clone https://github.com/alaingalvan/opengl-seed --recurse-submodules

# 💿 go inside the folder
cd opengl-seed

# 👯 If you forget to `recurse-submodules` you can always run:
git submodule update --init

# 👷 Make a build folder
mkdir build
cd build

# 🖼️ To build your Visual Studio solution on Windows x64
cmake .. -A x64

# 🍎 To build your XCode project on Mac OS
cmake .. -G Xcode

# 🐧 To build your .make file on Linux
cmake ..

# 🔨 Build on any platform:
cmake --build .

WebAssembly

Note: if you're on Windows, I would highly recommend using the Windows Subsystem for Linux.

First, install the latest version of Emscripten via the Emscripten SDK. Make sure to add it's Emscripten installation to your PATH, then:

# ⚠️ Possible dependencies you might need:
sudo apt-get update
sudo apt-get install cmake build-essential llvm

# 👷 Make a build folder
mkdir wasm
cd wasm

# 🔨 Build the project
emcmake cmake ..
emmake make OpenGLSeed -j

From there create an HTML file that loads the generated OpenGLSeed.js file, and run an http server. You can find an example of this here.

File Structure

├─ 📂 external/                    # 👶 Dependencies
│  ├─ 📁 crosswindow/                    # 🖼️ OS Windows
│  ├─ 📁 crosswindow-graphics/           # 🎨 GL Context Creation
│  ├─ 📁 glm/                            # ➕ Linear Algebra
│  ├─ 📁 opengl-registry/                # 📚 GL Headers
│  └─ 📁 glad/                           # 🙌 GL Extension Loader
├─ 📂 src/                         # 🌟 Source Files
│  ├─ 📄 Utils.h                         # ⚙️ Utilities (Load Files, Check Shaders, etc.)
│  ├─ 📄 Triangle.h                      # 🔺 Triangle Draw Code
│  ├─ 📄 Triangle.cpp                    # -
│  └─ 📄 Main.cpp                        # 🏁 Application Main
├─ 📄 .gitignore                   # 👁️ Ignore certain files in git repo
├─ 📄 CMakeLists.txt               # 🔨 Build Script
├─ 📄 license.md                   # ⚖️ Your License (Unlicense)
└─ 📃readme.md                     # 📖 Read Me!