wutipong-hp/sdl2-gl-project-template

sdl2-gl-project-template

sdl2-gl-project-template is a C++ template project which configured for OpenGL and SDL2. This template comes with the following libraries preconfigured.

• Simple DirectMedia Layer 2
• Dear Imgui
• gl3w: Simple OpenGL core profile loading
• OpenGL Mathematics

Above libraries are configured using Vcpkg Library Manager and Cmake.

Usage

Using Github template feature.

1. Clone this repository into your Github account.
2. Create a new project on Github with this project template.
3. Update the file vcpkg.json and CMakeLists.txt file to change the project name.

Manual Repository Setup

1. Clone this repository.
2. Remove the origin remote of your project so it does not point to the template repository.
3. Update the file vcpkg.json and CMakeLists.txt file to change the project name.

You may also want to set the new origin remote url, and may be squash the commit history so it does not contains any history of the template project.

Also since we use Vcpkg as the package management, you can also add new dependencies by updating the vcpkg.json. For more information please visit Vcpkg homepage.

Build the project

Using IDE

Visual Studio 2022 and Visual Studio Code supports CMake project directly, given that the right components are installed. Simply use Open Folder menu to open the project file inside.

Manually configure

• install cmake.
• run cmake <project directory> inside an empty directory to configure the project. The configure step might take some time as it build the dependencies projects at the fast time it is configured.
• run cmake --build . (. must be included in the command) to build the project.

Working with the project

Update the file scene.cpp to meet your requirement.

• Init() contains the initialization code.
• DoFrame() contains code that run each time a new frame is rendering.
• DoUI() contains the DearImGui code to perform user interface.
• CleanUp() contains the clean-up code.

Also if you don't need Dear ImGui-based UI, change the value of HasUI variable inside scene.hpp to false.

The project is configured to uses OpenGL 4.5. In the case that you have to work with different version, change the value of GlMajorVersion, GlMinorVersion and GlslVersion to the version you are using.

The shaders directory is where you're supposed to put shader files in. Any files in this directory will be copied to the build directory. This is preconfigured inside the CMakeLists.txt and can be changed or removed.

Last but not least, in the case that you need to add more file into the project, update the CMakeLists.txt file to accomodate those new files. If you're using VS2022, the IDE will be doing that for you (unless it can't figure out how).