WindowFrame Class Reference

Contains details and functions for use with the window. More...

#include <WindowFrame.h>

Collaboration diagram for WindowFrame:

Static Public Member Functions
static void	setWindow (std::string inTitle, Vec2 inWindowPos, Vec2 inWindowRes, bool inFullscreen, float inFrameRate)
	A static function to set a Window. More...
static void	setTitle (std::string inTitle)
	A static function to set the title of the window. More...
static void	setWindowPos (Vec2 inWindowPos)
	A static function to set the position of the window. More...
static void	setWindowRes (Vec2 inWindowRes)
	A static function to set the resolution of the window. More...
static void	setFullscreen (bool inFullscreen)
	A static function to set if the window should be fullscreen. More...
static void	setFrameRate (float inFrameRate)
	A static function to set the frame rate of the window. More...
static std::string	getTitle ()
	A static function to get the title of the window. More...
static Vec2	getWindowPos ()
	A static function to get the position of the window. More...
static Vec2	getWindowRes ()
	A static function to get the size of the window. More...
static bool	getFullscreen ()
	A static function to get if the window should be fullscreen. More...
static float	getFrameRate ()
	A static function to get the frame rate of the window. More...
static float	getAspect ()
	A static function to get the aspect of the window. More...

Static Private Attributes
static std::string	title
	The window title. More...
static Vec2	windowPos
	The position of the window. More...
static Vec2	windowRes
	The resolution of the window. More...
static bool	fullscreen
	A boolean for if the window should be fullscreen. More...
static float	frameRate
	The wanted frame rate of the window. More...

Detailed Description

Contains details and functions for use with the window.

Member Function Documentation

getAspect()

float WindowFrame::getAspect ( )

static

A static function to get the aspect of the window.

Returns

The aspect of the window.

Here is the caller graph for this function:

getFrameRate()

float WindowFrame::getFrameRate ( )

static

A static function to get the frame rate of the window.

Returns

The frame rate for the window.

Here is the caller graph for this function:

getFullscreen()

bool WindowFrame::getFullscreen ( )

static

A static function to get if the window should be fullscreen.

Returns

The boolean for fullscreen.

Here is the caller graph for this function:

getTitle()

std::string WindowFrame::getTitle ( )

static

A static function to get the title of the window.

Returns

The tile.

Here is the caller graph for this function:

getWindowPos()

Vec2 WindowFrame::getWindowPos ( )

static

A static function to get the position of the window.

Returns

The window position.

Here is the caller graph for this function:

getWindowRes()

Vec2 WindowFrame::getWindowRes ( )

static

A static function to get the size of the window.

Returns

The window resolution.

Here is the caller graph for this function:

setFrameRate()

void WindowFrame::setFrameRate ( float  inFrameRate )

static

A static function to set the frame rate of the window.

Parameters

frameRate

The frame rate for the window.

Here is the caller graph for this function:

setFullscreen()

void WindowFrame::setFullscreen ( bool  inFullscreen )

static

A static function to set if the window should be fullscreen.

Parameters

fullscreen

The boolean for fullscreen.

Here is the caller graph for this function:

setTitle()

void WindowFrame::setTitle ( std::string  inTitle )

static

A static function to set the title of the window.

Parameters

title

The tile.

Here is the caller graph for this function:

setWindow()

void WindowFrame::setWindow ( std::string  inTitle, Vec2  inWindowPos, Vec2  inWindowRes, bool  inFullscreen, float  inFrameRate  )

static

A static function to set a Window.

Parameters

inTitle	The tile.
inWindowPos	The window position.
inWindowRes	The window resolution.
inFullscreen	The boolean for fullscreen.
inFrameRate	The frame rate for the window.

Here is the call graph for this function:

Here is the caller graph for this function:

setWindowPos()

void WindowFrame::setWindowPos ( Vec2  inWindowPos )

static

A static function to set the position of the window.

Parameters

windowPos

The window position.

Here is the caller graph for this function:

setWindowRes()

void WindowFrame::setWindowRes ( Vec2  inWindowRes )

static

A static function to set the resolution of the window.

Parameters

windowRes

The window size.

Here is the caller graph for this function:

Member Data Documentation

frameRate

float WindowFrame::frameRate

staticprivate

The wanted frame rate of the window.

fullscreen

bool WindowFrame::fullscreen

staticprivate

A boolean for if the window should be fullscreen.

title

std::string WindowFrame::title

staticprivate

The window title.

windowPos

Vec2 WindowFrame::windowPos

staticprivate

The position of the window.

windowRes

Vec2 WindowFrame::windowRes

staticprivate

The resolution of the window.

---

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

• LevelHEngine/Core/WindowFrame.h
• LevelHEngine/Core/WindowFrame.cpp