Skip to content

Latest commit

 

History

History
46 lines (39 loc) · 1.64 KB

README.md

File metadata and controls

46 lines (39 loc) · 1.64 KB

SDL3 App From Source Minimal Example

This is a minimal example for building and using SDL3 from source using C++ and CMake. It also demonstrates setting up things like macOS/iOS bundles. See src/main.cpp for the code.

Building And Running

Are you a complete beginner? If so, read this! Otherwise, install CMake and your favorite compiler, and follow the commands below:

# You need to clone with submodules, otherwise SDL will not download.
git clone https://github.com/Ravbug/sdl3-sample --depth=1 --recurse-submodules
cd sdl3-sample
cmake -S . -B build

You can also use an init script inside config/. Then open the IDE project inside build/ (If you had CMake generate one) and run!

Supported Platforms

I have tested the following:

  • macOS
  • iOS
  • tvOS
  • visionOS
  • Windows
  • Linux
  • Web browsers (via Emscripten)*
  • Android*

*See further instructions in config/

Note: UWP support was removed from SDL3 during its development. For historical reasons, you can a working UWP sample via this commit: df270da

Updating SDL

Just update the submodule:

cd SDL
git pull

You don't need to use a submodule, you can also copy the source in directly. This repository uses a submodule to keep its size to a minimum. Note that as of writing, SDL3 is in development, so expect APIs to change.

Reporting issues

Is something not working? Create an Issue or send a Pull Request on this repository!