WraithEngine

The Wraith engine class is the core aspect of the program that runs everything. It also offers settings for the window display. More...

Collaboration diagram for WraithEngine:

Functions
static void	Wraith::SetWindowName (const char *windowName)
	Sets window name. More...
static void	Wraith::SetWindowWidthAndHeight (const int windowWidth, const int windowHeight)
	Sets window width and height. More...
static void	Wraith::SetBackgroundColor (const float red, const float green, const float blue, const float alpha)
	Sets background color of the window. More...
static int	Wraith::GetWindowWidth ()
	Gets window width. More...
static int	Wraith::GetWindowHeight ()
	Gets window height. More...

Detailed Description

The Wraith engine class is the core aspect of the program that runs everything. It also offers settings for the window display.

Useful tool for users include functions to set the window dimensions (width and height), background color, and name for the window (All of which should be called in the GameInitialize.cpp file). Users can also access the window width and height.

Here is an example of how these tools are used: NOTE: You must include Wraith.h header file to acesss Wraith functions.

\\ in GameInitialize.cpp
#include "Wraith.h"
 
void Wraith::gameInitialize()
{
    // Wraith Window Device setup
    Wraith::SetWindowName("Wraith Engine");
    Wraith::SetWindowWidthAndHeight(800, 600);
    Wraith::SetBackgroundColor(0.4f, 0.4f, 0.8f, 1.0f);
}
 
\\ in HUD.cpp (a user defined object)
#include "Wraith.h"
#include "Sprite.h"
 
HUD::HUD
{
    _pHealthBarSprite = new Sprite("HealthBarImage");
 
    // Here I want to set this HealthBarSprite to be in the top-center of the window.
    // NOTE (0, 0) is the bottom left corner of the screen
 
    float xPosition = (float) Wraith::GetWindowWidth() / 2.0f;
    float yPosition = (float) Wraith::GetWindowHeight() - _pHealthSprite->getHeight();
 
    _pHealthBarSprite->setPosition(xPosition, yPosition);
}

Function Documentation

GetWindowHeight()

static int Wraith::GetWindowHeight ( )

inlinestatic

Gets window height.

Returns

The window height.

GetWindowWidth()

static int Wraith::GetWindowWidth ( )

inlinestatic

Gets window width.

Returns

The window width.

SetBackgroundColor()

static void Wraith::SetBackgroundColor ( const float  red, const float  green, const float  blue, const float  alpha  )

inlinestatic

Sets background color of the window.

Parameters

red	The red value.
green	The green value.
blue	The blue value.
alpha	The alpha value.

SetWindowName()

static void Wraith::SetWindowName ( const char *  windowName )

inlinestatic

Sets window name.

Steven, 2/27/2021.

Parameters

windowName

Name of the window.

SetWindowWidthAndHeight()

static void Wraith::SetWindowWidthAndHeight ( const int  windowWidth, const int  windowHeight  )

inlinestatic

Sets window width and height.

Parameters

windowWidth	Width of the window.
windowHeight	Height of the window.