rapptz/gum

Thin C++11 SDL 2 wrapper with other nice things.

gum's Issues

File Stream

SDL offers a generic way of doing file I/O streaming. However, its API is very C-like. It'd be a good idea to offer a similar iostream interface though that might prove difficult.

Higher performance shape drawables

At the moment, there are some singular shapes that are drawables such as:

• point
• rectangle
• line

However, they use the singular form of the drawable using SDL_RenderDrawShape instead of SDL_RenderDrawShapes. For batching, there should be an alternative that uses the latter since the former would invoke a malloc and free call for only one and batching would invoke a malloc and free call for multiple instead of one.

Change the way includes are done

Move from "../stuff.hpp" way of including to <gum/thing/stuff.hpp> instead. Update documentation when doing so too.

Finish wrapping up window.

There are a lot of member functions that aren't provided by sdl::window. Would be a good idea to finish those.

Provide a way to refer to the SDL documentation.

There are a lot of references to the underlying SDL functions but the documentation doesn't externally link to them. It'd be cool if we could have a special directive for it. Something akin to :sdl:title. Should be worth researching to find out how to do this.

Provide different ways of error handling.

At the moment all errors are exceptions that are thrown. When I initially went into this, this seemed like a sensible thing to do because I assumed all errors that SDL reports must be substantial enough to warrant an exception thrown.

However, I soon realised this isn't the case. SDL decides to report errors for relatively small and silly things such as simple setters and getters. It might be a good idea to have a macro to change the error handling. Example:

#ifndef GUM_ERROR_HANDLER
#if defined(GUM_NO_EXCEPTIONS)
#define GUM_ERROR_HANDLER(x) SDL_Log("%s", sdl::last_error())
#else
#define GUM_ERROR_HANDLER(x) throw error()
#endif // GUM_NO_EXCEPTIONS
#endif // GUM_ERROR_HANDLER

Filesystem

Wrap up the small filesystem functions provided by SDL. Maybe provide other small utilities.

Events

Possibly wrap up SDL_Event. There's nothing inherently wrong with it, so just typedefs for consistency would do.

Display Mode

Wrap up SDL_DisplayMode and allow it to interact with sdl::window.

Message Boxes

SDL2 offers a nice platform independent way of doing message boxes. Would be nice to wrap them up a little.

Sprites

Would be cool to have an sdl::sprite that encapsulates a drawable object. I might work on this last though. This depends on issues:

• #10
• #9

Input

SDL offers a nice way to do input facilities. Wrapping them up would be good to do to make some distinctions clear.

Images

Find a way to wrap up SDL2_image. This allows loading of pngs, jpegs, etc.

Shapes.

SDL2 offers hardware accelerated primitives. Would be nice to wrap them up.

Some primitive shapes to wrap:

• A point
• Multiple points
• A rectangle
• Multiple rectangles
• A line
• Multiple lines

Texture

There's currently no way to create a texture to render anything to. Should probably wrap it around. This is relevant to issue #9 due to textures also being in part images/surfaces.

Audio

Wrap up SDL_audio.h. Note that this would probably mean wrapping up SDL_mixer.

Provide thickness for rectangle

Currently sdl::rectangle has only a one pixel thickness. Would be nice to be able to customise this.