SDL3pp

A "port" of SDL3 in C++.

This basically wrap SDL3 naturally OO looking concepts into proper C++ classes and objects, trying to as straightforward as possible. It was inspired on SDL2pp, with the addition of flexible memory management and wrappers for string and callbacks.

Quick start / TLDR

• Download the latest release;
• Build instructions;
• Installation instructions;
• See API reference;
• See Example and Examples directory.

Goals

• Be header only, we are only wrapping SDL here;
• Mostly wrap the naturally OO-looking API into actual OO C++ constructs;
  • Also add little quick improvements like using vocabulary types to better fit C++ idioms;
  • See transformations for more details;
• Put everything into a SDL namespace instead of prefixes;
  • For uniformity we also wrap non OO entities at lower priority (like aliases, functions, constants, etc);
• Interfaces should accept both C structs and the C++ wraps, so you can adapt a codebase gradually or just choose to use only what you deem necessary.
• Flexible, while we use RAII idiom by default, you have the choice to not use it and, for example, manage memory yourself.

Documentation

• See API by Category for some examples.
• See transformations to understand the design approach.
• See Design notes to understand the rationally behind some design patterns and choices we use.
• See our source code;
• See the examples directory
• See most recent version of this Doxygen

Example

#include <iostream>
#include <SDL3pp/SDL3pp.h>
#include <SDL3pp/SDL3pp_main.h>
 
using namespace std::chrono_literals;
 
int main(int argc, char** argv)
{
  SDL::Init(SDL::INIT_VIDEO);
  constexpr SDL::Point WINDOW_SZ = {400, 400};
  auto [window, renderer] = SDL::CreateWindowAndRenderer("Test", WINDOW_SZ);
 
  SDL::Texture characterTexture{
    renderer, std::format("{}../assets/smiley.png", SDL::GetBasePath())};
  SDL::FRect characterRect(SDL::FPoint(WINDOW_SZ) / 2 - SDL::FPoint{64, 64},
                           {128, 128});
 
  bool running = true;
  while (running) {
    while (auto ev = SDL::PollEvent()) {
      if (ev->type == SDL::EVENT_QUIT) { running = false; }
    }
    renderer.SetDrawColorFloat({.5f, .5f, .5f, 1.f});
    renderer.RenderClear();
    renderer.SetDrawColorFloat({0.f, 0.725f, 0.f, 1.f});
    renderer.RenderFillRect(SDL::FRect{10, 10, 380, 380});
    renderer.RenderTexture(characterTexture, {}, characterRect);
 
    renderer.Present();
    SDL::Delay(1ns);
  }
 
  return 0;
}

See more examples at examples directory

Building

Assuming you are on the source dir, you can build with:

cmake -S . -B build
cmake --build build

Installing

There are a few ways to install SDL3pp:

Copy into project

The most basic way is to copy the contents of amalgamation/ or include directly to your project.

System installation:

After build, you can install on you system with cmake:

cmake --install build

Alteratively can move into a custom location with:

cmake --install build --install-prefix <directory>