Wraith  0.1.5
Basic 3D game engine in C++
Wraith Class Reference
Inheritance diagram for Wraith:
Inheritance graph
Collaboration diagram for Wraith:
Collaboration graph

Static Public Member Functions

static void Run ()
 Begins and runs the engine. More...
 
static void SetWindowName (const char *windowName)
 Sets window name. More...
 
static void SetWindowWidthAndHeight (const int windowWidth, const int windowHeight)
 Sets window width and height. More...
 
static void SetBackgroundColor (const float red, const float green, const float blue, const float alpha)
 Sets background color of the window. More...
 
static int GetWindowWidth ()
 Gets window width. More...
 
static int GetWindowHeight ()
 Gets window height. More...
 
static void Delete ()
 Terminates engine and other resources and managers. More...
 

Private Member Functions

 Wraith (const Wraith &)=delete
 
Wraithoperator= (const Wraith &)=delete
 
 Wraith (Wraith &&)=delete
 
Wraithoperator= (Wraith &&)=delete
 
void loadResources ()
 User defined area where the user loads resources. More...
 
void gameInitialize ()
 User defined are for initializing the game. More...
 
void gameEnd ()
 User defined function where any clean up by the user is needed. More...
 
virtual void Initialize () override
 Initializes game settings./ More...
 
virtual void LoadContent () override
 Loads the game contents such as user resources. More...
 
virtual void Update () override
 Updates Game data such as scene (with its asscoated managers and game object entities). More...
 
virtual void Draw () override
 Draws all graphics object exisiting within a scene. More...
 
virtual void UnLoadContent () override
 Unloads content from the game. More...
 
 Wraith (const char *windowName, const int Width, const int Height)
 

Static Private Member Functions

static WraithGetInstance ()
 
static float GetTimeInSeconds ()
 Gets time in seconds. More...
 
static void PrintTitleMessage (const std::string &)
 

Static Private Attributes

static WraithpGameInstance = nullptr
 

Friends

class WraithAttorney
 

Member Function Documentation

◆ Delete()

void Wraith::Delete ( )
static

Terminates engine and other resources and managers.

◆ Draw()

void Wraith::Draw ( )
overrideprivatevirtual

Draws all graphics object exisiting within a scene.

◆ GetTimeInSeconds()

static float Wraith::GetTimeInSeconds ( )
inlinestaticprivate

Gets time in seconds.

This a private function that is NEVER called by the user. Time accessed by the TimeManager

Returns
The time in seconds.

◆ Initialize()

void Wraith::Initialize ( )
overrideprivatevirtual

Initializes game settings./

◆ LoadContent()

void Wraith::LoadContent ( )
overrideprivatevirtual

Loads the game contents such as user resources.

.

◆ Run()

static void Wraith::Run ( )
inlinestatic

Begins and runs the engine.

Only to be called in main.cpp.

◆ UnLoadContent()

void Wraith::UnLoadContent ( )
overrideprivatevirtual

Unloads content from the game.

◆ Update()

void Wraith::Update ( )
overrideprivatevirtual

Updates Game data such as scene (with its asscoated managers and game object entities).


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