Documentation: Red - OutOfTheVoid/ProjectRed GitHub Wiki

( Up one level: Root )

Overview

Red is the game engine main library.

It contains the highest level abstractions and the most basic of utilities for making things run. It depends on all other sub-libraries for several tasks ( and cannot be compiled without them. )

The overall namespace is defined in Red/Red.h

There are configuration options defined in Red/Options.h

The define RED_OPT_TEXT_RENDERING_FREETYPE configures whether or not libfreetype should be used for rendering text. ( Currently, freetype is the only supported font rendering library. )

Classes and namespaces defined in the 'Red' namespace:

• Audio: The namespace containing all of Red's audio code, including dynamic synthesis and playback
• Events: The namespace containing the Red event system
• Graphics: The namespace containing all code related to GFX, ( text withstanding ) which runs on top of Xenon
• Math: The namespace containing all general-purpose mathematical code
• Text: The namespace containing all code related to text rendering, which runs on top of Xenon
• Threading: The namespace containing all code related to multithreading and synchronization
• Util: The namespace containing all utility and extra code supporting the Red library (and others)