---

GAUGE3D::GEngine Class Reference

Used to initialize the engine. More...

#include <gauge3d/engine.h>

List of all members.

Public Types
enum	tSubSystems {   INPUT = 1 << 0, VIDEO = 1 << 1, FILESYSTEM = 1 << 2, OBJECT_LOADER = 1 << 3,   ALL_SUBSYSTEMS = 0x7FFFFFFF }
	Bits for subsystems. More...
Static Public Methods
void	CommandLine (int argc,char *argv[])
	Call this when your program starts to tell GAUGE the command-line arguments used.
void	CommandLine (char *args)
	Call this when your program starts to tell GAUGE the command-line arguments used.
void	CommandLine (int argc,GString argv[])
	Call this when your program starts to tell GAUGE the command-line arguments used.
void	CommandLine (GArray< GString >args)
	Call this when your program starts to tell GAUGE the command-line arguments used.
GArray<GString>	CommandLine ()
	Get the command-line arguments.
void	ProgName (GString name)
GString	ProgName ()
	Get the program's name.
void	Init (int subsystems)
int	InitializedSubSystems ()
	Get the initialized subsystems.
void	ShutdownSubSystem (int subsystems)
	Shutdown one or more subsystems.
void	Shutdown ()
	Shutdown the engine and all active subsystems.
void	MainLoop ()
	Execute main loop. More...
void	Quit ()
	Stop the main loop. More...

---

Detailed Description

Used to initialize the engine.

All the functions in this class are static.

---

Member Enumeration Documentation

enum GAUGE3D::GEngine::tSubSystems

Bits for subsystems. Enumeration values: INPUT   Input subsystem (message handling). VIDEO   Video and 3D rendering subsystem. FILESYSTEM   File I/O and data stream subsystem. OBJECT_LOADER   Object/Plugin loader subsystem. ALL_SUBSYSTEMS   All subsystems.

---

Member Function Documentation

void GAUGE3D::GEngine::ProgName ( GString name ) [static]

\breif Set the program's name. ameter name This should be a short name for the program consisting of only lower-case letters, numerals, hyphens, and underscores. Depending on the OS, this name may be used for file and directory names. For example, on unix-like OS's, the user's config directory will be "~/.progname", where "progname" is the name you specify.

void GAUGE3D::GEngine::Init ( int subsystems ) [static]

\breif Initialize the engine and one or more sub-systems. Parameters: subsystems   A bitwise OR of one or more of the values of tSubSystems. You may call Init() multiple times, or initialize everything at once.

void GAUGE3D::GEngine::MainLoop ( ) [static]

Execute main loop. While running the main loop, GAUGE will repeatedly call the DoFrame() functions of each subsystem's scheduler. See GScheduler for more.

void GAUGE3D::GEngine::Quit ( ) [static]

Stop the main loop. MainLoop() will return on the frame after Quit() is called.

---

The documentation for this class was generated from the following file:

• gauge3d/engine.h

---