Ketchup Class Reference

#include <Ketchup.h>

Inheritance diagram for Ketchup:

Collaboration diagram for Ketchup:

Static Public Member Functions
static Ketchup *	Instance ()
static void	AttachSettings (EngineSettings *settings)
	Attaches user-defined EngineSettings class to the game. To be set in main before calling Run().
static void	Run ()
	Runs the Ketchup Engine.
static int	GetWidth ()
	Returns the current window width.
static int	GetHeight ()
	Returns the current window height.

Private Member Functions
	Ketchup ()
	~Ketchup ()
void	Initialize ()
void	LoadContent ()
void	Update ()
void	Draw ()
void	UnLoadContent ()
void	SetWindowName (const char *pWindowName)
void	SetWidthHeight (const int width, const int height)
void	SetVsync (bool enable)

Static Private Member Functions
static void	Free ()
static float	GetTimeInSeconds ()

Private Attributes
EngineSettings *	p_settings

Static Private Attributes
static Ketchup *	p_instance

Friends
class	KetchupAttorney

Constructor & Destructor Documentation

Ketchup()

Ketchup::Ketchup ( )

private

~Ketchup()

Ketchup::~Ketchup ( )

private

Member Function Documentation

AttachSettings()

void Ketchup::AttachSettings ( EngineSettings *  settings )

static

Attaches user-defined EngineSettings class to the game. To be set in main before calling Run().

Haru, 3/22/2023.

Parameters

settings

A pointer to a class instance inheriting from EngineSettings.

Draw()

void Ketchup::Draw ( )

private

Free()

void Ketchup::Free ( )

staticprivate

GetHeight()

int Ketchup::GetHeight ( )

static

Returns the current window height.

Haru, 3/1/2023.

Returns

The window height.

GetTimeInSeconds()

float Ketchup::GetTimeInSeconds ( )

staticprivate

GetWidth()

int Ketchup::GetWidth ( )

static

Returns the current window width.

Haru, 3/1/2023.

Returns

The window width.

Initialize()

void Ketchup::Initialize ( )

private

Instance()

Ketchup * Ketchup::Instance ( )

static

LoadContent()

void Ketchup::LoadContent ( )

private

Run()

void Ketchup::Run ( )

static

Runs the Ketchup Engine.

To be called in main

SetVsync()

void Ketchup::SetVsync ( bool  enable )

private

SetWidthHeight()

void Ketchup::SetWidthHeight ( const int  width, const int  height  )

private

SetWindowName()

void Ketchup::SetWindowName ( const char *  pWindowName )

private

UnLoadContent()

void Ketchup::UnLoadContent ( )

private

Update()

void Ketchup::Update ( )

private

Friends And Related Function Documentation

KetchupAttorney

friend class KetchupAttorney

friend

Member Data Documentation

p_instance

Ketchup * Ketchup::p_instance

staticprivate

p_settings

EngineSettings* Ketchup::p_settings

private

---

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

• Ketchup.h
• Ketchup.cpp