TheCloud/libSDL2pp
1
0
Fork 0
mirror of https://github.com/libSDL2pp/libSDL2pp.git synced 2025-08-04 03:15:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Dmitry Marakasov 2014-02-01 03:32:46 +04:00
parent c3702a1eb8
commit a64d6825d5
1 changed files with 37 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -1,8 +1,6 @@
# libSDL2pp # # libSDL2pp #
This library provides C++ bindings/wrappers for SDL2. This library provides C++11 bindings/wrappers for SDL2.
This library uses C++11!
## Synopsis ## ## Synopsis ##
@ -44,24 +42,41 @@ try {
} }
``` ```
## Completeness ## ## Features ##
For now I only implement functionality I need myself, so the library Currently, the library provides wrapper classes for
is not nearly complete. However, patches (as well as requests for
adding new functionality) are welcome. * 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, with which you can store e.g. texture
objects and containers and returb by value with no overhead
## Building ## ## Building ##
Dependencies: Dependencies:
- cmake * cmake
- SDL2 * SDL2
To build standalone version: To build standalone version:
```cmake . && make``` ```cmake . && make```
## Bundling ## ## Bundling ##
The library is easy to integrate into other CMake-using projects. 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 Just place the library into dedicated directory in your project
(for example, lib/SDL2pp) and add (for example, lib/SDL2pp) and add
@ -69,9 +84,10 @@ Just place the library into dedicated directory in your project
```cmake ```cmake
ADD_SUBDIRECTORY(lib/SDL2pp) ADD_SUBDIRECTORY(lib/SDL2pp)
``` ```
into your core CMakeLists.txt. This will act as similar to what into your core CMakeLists.txt. This will act as similar to what
FIND_PACKAGE usually does, and will provide ${SDL2PP_INCLUDE_DIRS} FIND_PACKAGE usually does, and will provide ${SDL2PP_INCLUDE_DIRS}
and ${SDL2PP_LIBRARIES} variables for your project. You will the and ${SDL2PP_LIBRARIES} variables for your project. You will then
be able to use them as usual: be able to use them as usual:
```cmake ```cmake
@ -81,8 +97,15 @@ ADD_EXECUTABLE(mytarget ...)
TARGET_LINK_LIBRARIES(mytarget ${SDL2PP_LIBRARIES}) TARGET_LINK_LIBRARIES(mytarget ${SDL2PP_LIBRARIES})
``` ```
if bundled, libSDL2pp will not build a demo and will be a static if bundled, libSDL2pp does not build demos and becomes a static
library, providing SDL2 includes/libs in the mentioned variables. 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.
## Author ## ## Author ##
@ -90,7 +113,7 @@ library, providing SDL2 includes/libs in the mentioned variables.
## Contributors ## ## Contributors ##
* You name here! * [Carl Schwope](https://github.com/Lowest0ne)
## License ## ## License ##