Documentation

Documentation is in progress

Getting started

A following code snippet shows you how to start working with the engine. It will initialize the engine singleton and setup a basic logging capabilities.

#include <nrEngine/nrEngine.h>

void main()
{
    // initialize logging
    Engine::instance()->initializeLog("log/");
    Engine::sLog()->setLevel(Log::LL_WARNING);

    // initialiye essential parts of the engine
    Engine::instance()->initializeEngine();


    ....


    // release the engine and free memory
    Engine::release();
}