Gamedev Framework (gf) Documentation

Table of Contents

• First example
• Documentation
• Source

Gamedev Framework (gf) is a framework to build 2D games in C++11. It is based on SDL and OpenGL ES 2.0, and presents an API that is very similar to the graphics module of SFML (see Differences with SFML) with additional features. It is not a game engine, it is more something like a framework, similar to libGDX in the Java world.

Gamedev Framework (gf) is licensed under the terms and conditions of the zlib/libpng license.

First example

#include <gf/Event.h>
#include <gf/Font.h>
#include <gf/RenderWindow.h>
#include <gf/Sprite.h>
#include <gf/Text.h>
#include <gf/Window.h>

int main() {
  // Create the main window and the renderer

  gf::Window window("Example", { 640, 480 });
  gf::RenderWindow renderer(window);

  // Load a sprite to display

  gf::Texture texture;
  if (!texture.loadFromFile("sprite.png")) {
    return EXIT_FAILURE;
  }

  gf::Sprite sprite(texture);
  sprite.setPosition({ 300, 200 });

  // Create a graphical text to display

  gf::Font font;
  if (!font.loadFromFile("DroidSans.ttf")) {
    return EXIT_FAILURE;
  }

  gf::Text text("Hello gf!", font, 50);
  text.setPosition({ 100, 100 });

  renderer.clear(gf::Color::White);

  // Start the game loop

  while (window.isOpen()) {

    // Process events

    gf::Event event;

    while (window.pollEvent(event)) {
      switch (event.type) {
        case gf::EventType::Closed:
          window.close();
          break;

        default:
          break;
      }
    }

    // Draw the entities

    renderer.clear();
    renderer.draw(sprite);
    renderer.draw(text);
    renderer.display();
  }

  return 0;
}

Documentation

1. Introduction to gf
   • Features of Gamedev Framework (gf)
   • Build and install gf
   • Differences with SFML
   • Recommanded libraries
2. Tutorials on gf
   • Gamedev 101
   • Start a game with gf
3. User documentation (WIP)
   1. Core classes
      • Safe singletons
      • Making noise
   2. Graphics classes
      • How to write your own shader
   3. Game classes
      • Game messages

Source

The source code is available on github.