Skip to content

Latest commit

 

History

History
134 lines (94 loc) · 3.73 KB

README.md

File metadata and controls

134 lines (94 loc) · 3.73 KB
Raw

libSDL2pp

This library provides C++11 bindings/wrappers for SDL2.

Synopsis

try {
  // Init SDL; will be automatically deinitialized when the object is destroyed
  SDL2pp::SDL sdl(SDL_INIT_VIDEO);

  // Straightforward wrappers around corresponding SDL2 objects
  // These take full care of proper object destruction and error checking
  SDL2pp::Window window("libSDL2pp demo",
                        SDL_WINDOWPOS_UNDEFINED, SDL_WINDOWPOS_UNDEFINED,
                        640, 480, SDL_WINDOW_RESIZABLE);
  SDL2pp::Renderer renderer(window, -1, SDL_RENDERER_ACCELERATED);
  SDL2pp::Texture sprite1(renderer, SDL_PIXELFORMAT_ARGB8888,
                         SDL_TEXTUREACCESS_STATIC, 16, 16);
  SDL2pp::Texture sprite2(renderer, "sprite.png"); // SDL_image support

  unsigned char pixels[16 * 16 * 4];

  // Note proper constructor for Rect
  sprite1.Update(SDL2pp::Rect(0, 0, 16, 16), pixels, 16 * 4);

  renderer.Clear();

  // Also note a way to specify null rects
  renderer.Copy(sprite1, SDL2pp::Rect::Null(), SDL2pp::Rect::Null());

  // Copy() is overloaded, providing access to both SDL_RenderCopy and SDL_RenderCopyEx
  renderer.Copy(sprite2, SDL2pp::Rect::Null(), SDL2pp::Rect::Null(), 45.0);

  renderer.Present();

  // You can still access wrapped C SDL types
  SDL_Renderer* sdl_renderer = renderer.Get();

  // Of course, C SDL2 API is still perfectly valid
  SDL_Delay(2000);

  // All SDL objects are released at this point or if an error occurs
} catch (SDL2pp::Exception& e) {
  // Exception stores SDL_GetError() result
  std::cerr << "Exception: " << e.what() << std::endl;
  std::cerr << "SDL Error: " << e.GetSDLError() << std::endl;
}

Features

Currently, the library provides wrapper classes for

  • SDL iteslf
  • SDL_Point
  • SDL_Rect
  • SDL_Renderer
  • SDL_Texture
  • SDL_Window

each with subset of methods corresponding to SDL functions working with sepcific type of object and in some cases additional convenience methods. These classes also support:

  • RAII-style initialization and destruction
  • Full error checking: exception is thrown if any SDL function fails. Exception itself allows to retrieve SDL error string
  • C++11 move semantics support, which allow you to store SDL objects in containers and pass/return them by value with no overhead

Building

Dependencies:

  • cmake
  • SDL2
  • SDL_image2 (optional)

To build standalone version: cmake . && make

Bundling

The library is easy to integrate into other CMake-using projects (and as the library has no stable API yet, this way of using it is preferred).

Just place the library into dedicated directory in your project (for example, lib/SDL2pp) and add

SET(SDL2PP_WITH_IMAGE ON) # if you need SDL_image support
ADD_SUBDIRECTORY(lib/SDL2pp)

into your core CMakeLists.txt. This will act as similar to what FIND_PACKAGE usually does, and will provide ${SDL2PP_INCLUDE_DIRS} and ${SDL2PP_LIBRARIES} variables for your project. You will then be able to use them as usual:

INCLUDE_DIRECTORIES(${SDL2PP_INCLUDE_DIRS})

ADD_EXECUTABLE(mytarget ...)
TARGET_LINK_LIBRARIES(mytarget ${SDL2PP_LIBRARIES})

if bundled, libSDL2pp does not build demos and becomes a static library, providing required SDL2 includes/libs in the mentioned variables.

Completeness

For now I only implement functionality I need myself, so the library is not nearly complete. However, patches (as well as requests for adding new functionality) are welcome.

Users

Projects using libSDL2pp:

Author

Contributors

License

libSDL2pp comes under zlib license, the same license as SDL2.