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 single header and add to your project;
• See API reference;
• See Examples directory.

Goals

• Be header only, we are mostly wrapping thing here;
  • We even have a the single header to just put in your project
• 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 most recent Doxygen
  • See Api reference;
  • See Transformations to understand the strategies we adopt to map we do from C to C++;
  • See Design notes to understand the rationally behind some design patterns and choices we use.
• See the examples directory for some examples;
• See our roadmap-like todo.

Example

#include <iostream>
#include <SDL3/SDL_main.h>
#include "SDL3pp/SDL3pp.h"
 
using namespace std::chrono_literals;
 
int main(int argc, char** argv)
{
  SDL::SDL init(SDL::INIT_VIDEO);
  if (!init) {
    SDL_Log("%s", SDL::GetError());
    return 1;
  }
  auto [window, renderer] = SDL::CreateWindowAndRenderer("Test", {400, 400});
  if (!window) {
    SDL_Log("%s", SDL::GetError());
    return 1;
  }
  bool running = true;
  while (running) {
    while (auto ev = SDL::PollEvent()) {
      if (ev->type == SDL_EVENT_QUIT) { running = false; }
    }
    renderer.SetDrawColor(SDL::FColor{.5f, .5f, .5f, 1.f});
    renderer.RenderClear();
    renderer.SetDrawColor(SDL::FColor{0.f, 1.f, 0.f, 1.f});
    renderer.RenderFillRect(SDL::FRect{10, 10, 128, 128});
 
    renderer.Present();
    SDL::Delay(1ns);
  }
 
  return 0;
}

examples directory

Building

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

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

Installing is not supported yet, but hopefully will be in the future.