The Amnesia Engine

Introduction

Welcome to the AmnesiaEngine documentation, a wealth of valuable information about the engine. If you are looking for tutorials, please visit amnesiaengine.sourceforge.net, or take a look in the /tutorials directory.

Links

Namespaces: A very good place to start reading the documentation.
Class list: List of all classes with descriptions.
Class members: Good place to find forgotten features.

Example

#include <IEngine.h>
using namespace amn;

int main(int argc, char* argv[])
{
        //create the engine
        IEngine* engine = createEngine("myConfigFile.xml");

        //main loop
        while(engine->update()) //while the window is still open
        {
                engine->getVideoDevice()->beginRender(); //begin render

                engine->getVideoDevice()->endRender(); //end render
        }

        engine->drop(); //delete the device
        return 0;
}

License

Copyright (c) 2006 John DiSanti.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---