diff --git a/README.md b/README.md index d63fc6d..8cb35cb 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,67 @@ -## blah -A small 2D C++ Game Framework, using few dependencies and simple code to mainain easy building and portability. - -**☆ This will likely see breaking changes! Use at your own risk! ☆** - -#### building - - Requires C++17 and CMake 3.12+ - - A single *Platform* backend must be enabled: - - [SDL2](https://github.com/NoelFB/blah/blob/master/src/internal/platform_backend_sdl2.cpp) can be enabled in CMake with `PLATFORM_SDL2`, and setting `SDL2_INCLUDE_DIRS` and `SDL2_LIBRARIES` - - [WIN32](https://github.com/NoelFB/blah/blob/master/src/internal/platform_backend_win32.cpp) (UNFINISHED) can be enabled in CMake with `PLATFORM_WIN32`. - - Additional backends can be added by implementing the [Platform Backend](https://github.com/NoelFB/blah/blob/master/src/internal/platform_backend.h) - - A single *Graphics* backend must be enabled: - - [OpenGL](https://github.com/NoelFB/blah/blob/master/src/internal/graphics_backend_gl.cpp) can be enabled in CMake with `GRAPHICS_OPENGL`. - - [D3D11](https://github.com/NoelFB/blah/blob/master/src/internal/graphics_backend_d3d11.cpp) can be enabled in CMake with `GRAPHICS_D3D11`. - - Additional backends can be added by implementing the [Graphics Backend](https://github.com/NoelFB/blah/blob/master/src/internal/graphics_backend.h). - -#### notes - - There's no Shader abstraction, so the [Sprite Batcher](https://github.com/NoelFB/blah/blob/master/src/graphics/batch.cpp) has hard-coded GLSL/HLSL. This will need to change. - - Only floatN/mat3x2/mat4x4 uniforms are supported. - - There's no Audio API or backend implementation yet. - - No threaded rendering so it will explode if you try that. - -#### a sample application - -```cpp -#include -using namespace Blah; - -Batch batch; -TextureRef tex; - -void startup() -{ - tex = Texture::create("player.png"); -} - -void render() -{ - App::backbuffer->clear(Color::black); - - auto center = Vec2(App::backbuffer->width(), App::backbuffer->height()) / 2; - auto rotation = Time::seconds * Calc::TAU; - auto transform = Mat3x2::create_transform(center, Vec2::zero, Vec2::one, rotation); - - batch.push_matrix(transform); - batch.rect(Rect(-32, -32, 64, 64), Color::red); - batch.tex(tex, Vec2(64, 0), Color::white); - batch.pop_matrix(); - - batch.render(); - batch.clear(); -} - -int main() -{ - Config config; - config.name = "blah app"; - config.width = 1280; - config.height = 720; - config.on_startup = startup; - config.on_render = render; - - App::run(&config); - return 0; -} - -``` +## blah +A small 2D C++ Game Framework, using few dependencies and simple code to mainain easy building and portability. + +**☆ This will likely see breaking changes! Use at your own risk! ☆** + +#### building + - Requires C++17 and CMake 3.12+ + - A single *Platform* backend must be enabled: + - [SDL2](https://github.com/NoelFB/blah/blob/master/src/internal/platform_sdl2.cpp) can be enabled in CMake with `PLATFORM_SDL2`, and setting `SDL2_INCLUDE_DIRS` and `SDL2_LIBRARIES` + - [WIN32](https://github.com/NoelFB/blah/blob/master/src/internal/platform_win32.cpp) (UNFINISHED) can be enabled in CMake with `PLATFORM_WIN32`. + - Additional backends can be added by implementing the [Platform Backend](https://github.com/NoelFB/blah/blob/master/src/internal/platform.h) + - A single *Graphics* backend must be enabled: + - [OpenGL](https://github.com/NoelFB/blah/blob/master/src/internal/graphics_gl.cpp) can be enabled in CMake with `GRAPHICS_OPENGL`. + - [D3D11](https://github.com/NoelFB/blah/blob/master/src/internal/graphics_d3d11.cpp) can be enabled in CMake with `GRAPHICS_D3D11`. + - Additional backends can be added by implementing the [Graphics Backend](https://github.com/NoelFB/blah/blob/master/src/internal/graphics.h). + +#### notes + - There's no Shader abstraction, so the [Sprite Batcher](https://github.com/NoelFB/blah/blob/master/src/graphics/batch.cpp) has hard-coded GLSL/HLSL. This will need to change. + - Only floatN/mat3x2/mat4x4 uniforms are supported. + - There's no Audio API or backend implementation yet. + - No threaded rendering so it will explode if you try that. + +#### a sample application + +```cpp +#include +using namespace Blah; + +Batch batch; +TextureRef tex; + +void startup() +{ + tex = Texture::create("player.png"); +} + +void render() +{ + App::backbuffer->clear(Color::black); + + auto center = Vec2(App::backbuffer->width(), App::backbuffer->height()) / 2; + auto rotation = Time::seconds * Calc::TAU; + auto transform = Mat3x2::create_transform(center, Vec2::zero, Vec2::one, rotation); + + batch.push_matrix(transform); + batch.rect(Rect(-32, -32, 64, 64), Color::red); + batch.tex(tex, Vec2(64, 0), Color::white); + batch.pop_matrix(); + + batch.render(); + batch.clear(); +} + +int main() +{ + Config config; + config.name = "blah app"; + config.width = 1280; + config.height = 720; + config.on_startup = startup; + config.on_render = render; + + App::run(&config); + return 0; +} + +```