Application base class, please make sure to allocate application on heap to have correct application shutdown working. More...

#include <tdme/application/Application.h>

Inheritance diagram for Application:

Collaboration diagram for Application:

Public Member Functions
	Application ()
	Public constructor. More...

virtual	~Application ()
	Destructor. More...

const string &	getTitle ()

const string &	getExecutableFileName ()

bool	isDebuggingEnabled ()

void	setInputEventHandler (InputEventHandler *inputEventHandler)
	Set input event handler. More...

int	getWindowXPosition () const

void	setWindowXPosition (int windowXPosition)
	Set window X position when initializing. More...

int	getWindowYPosition () const

void	setWindowYPosition (int windowYPosition)
	Set window Y position when initializing. More...

int	getWindowWidth () const

void	setWindowWidth (int windowWidth)
	Set window width. More...

int	getWindowHeight () const

void	setWindowHeight (int windowHeight)
	Set window height. More...

bool	isFullScreen () const

void	setFullScreen (bool fullScreen)
	Set full screen mode. More...

string	getClipboardContent ()

void	setClipboardContent (const string &content)
	Set clipboard content. More...

void	run (int argc, char *argv, const string &title, InputEventHandler inputEventHandler=nullptr, int windowHints=WINDOW_HINT_NONE)
	Run this application. More...

virtual void	initialize ()=0
	Init. More...

virtual void	reshape (int width, int height)=0
	Resize. More...

virtual void	display ()=0
	Display. More...

virtual void	dispose ()=0
	Disposes. More...

virtual void	onClose ()
	On close. More...

Static Public Member Functions
static Renderer *	getRenderer ()

static bool	hasApplication ()

static Application *	getApplication ()

static bool	isLimitFPS ()

static void	setLimitFPS (bool limitFPS)
	Set frames per seconds limit. More...

static void	setVSyncEnabled (bool vSync)
	Set vsync enabled. More...

static string	getOSName ()

static string	getCPUName ()

static string	execute (const string &command)
	Execute a command and wait until it finished running. More...

static void	executeBackground (const string &command)
	Execute a command in background. More...

static void	openBrowser (const string &url)
	Open browser with given url. More...

static void	cancelExit ()
	Cancels a users requested exit (ALT-F4 or X button) More...

static void	exit (int exitCode)
	Exits this application with given exit code. More...

static bool	isActive ()

static void	installExceptionHandler ()
	Windows only: Install exception handler that will print a stack trace if crashing. More...

static void	setMouseCursor (int mouseCursor)
	Set mouse cursor. More...

static int	getMousePositionX ()

static int	getMousePositionY ()

static void	setMousePosition (int x, int y)
	Set mouse position. More...

static void	swapBuffers ()
	Swap rendering buffers. More...

Static Public Attributes
static constexpr int	WINDOW_HINT_NONE { 0 }

static constexpr int	WINDOW_HINT_NOTRESIZEABLE { 1 }

static constexpr int	WINDOW_HINT_NOTDECORATED { 2 }

static constexpr int	WINDOW_HINT_INVISIBLE { 4 }

static constexpr int	WINDOW_HINT_MAXIMIZED { 8 }

static constexpr int	FPS { 60 }

Private Member Functions
void	setIcon ()
	Set application icon. More...

Static Private Member Functions
static void	displayInternal ()
	Display function. More...

static void	reshapeInternal (int width, int height)
	Reshape function. More...

static void	glfwOnChar (GLFWwindow *window, unsigned int key)
	GLFW on char. More...

static void	glfwOnKey (GLFWwindow *window, int key, int scanCode, int action, int mods)
	GLFW on key. More...

static void	glfwOnMouseMoved (GLFWwindow *window, double x, double y)
	GLFW on mouse moved. More...

static void	glfwOnMouseButton (GLFWwindow *window, int button, int action, int mods)
	GLFW on key. More...

static void	glfwOnMouseWheel (GLFWwindow *window, double x, double y)
	GLFW on key. More...

static void	glfwOnWindowResize (GLFWwindow *window, int width, int height)
	GLFW on window resize. More...

static void	glfwOnClose (GLFWwindow *window)
	GLFW on close. More...

Private Attributes
int	windowHints { WINDOW_HINT_NONE }

string	executableFileName

bool	debuggingEnabled { false }

bool	initialized { false }

int	windowWidth { 1024 }

int	windowHeight { 768 }

int	windowXPosition { -1 }

int	windowYPosition { -1 }

bool	fullScreen { false }

string	title

int	exitCode { 0 }

Static Private Attributes
static STATIC_DLL_IMPEXT Renderer *	renderer = nullptr

static STATIC_DLL_IMPEXT Application *	application = nullptr

static STATIC_DLL_IMPEXT InputEventHandler *	inputEventHandler = nullptr

static STATIC_DLL_IMPEXT int64_t	timeLast = -1L

static STATIC_DLL_IMPEXT bool	limitFPS = true

static STATIC_DLL_IMPEXT GLFWwindow *	glfwWindow = nullptr

static STATIC_DLL_IMPEXT array< unsigned int, 10 >	glfwMouseButtonDownFrames

static STATIC_DLL_IMPEXT int	glfwMouseButtonLast = -1

static STATIC_DLL_IMPEXT bool	glfwCapsLockEnabled = false

static STATIC_DLL_IMPEXT GLFWcursor *	glfwHandCursor = nullptr

Friends
class	InputEventHandler

class	tdme::engine::subsystems::renderer::VKRenderer

Detailed Description

Application base class, please make sure to allocate application on heap to have correct application shutdown working.

Author: Andreas Drewke

Version: $Id$

Definition at line 36 of file Application.h.

Constructor & Destructor Documentation

◆ Application()

Application ( )

Public constructor.

Definition at line 335 of file Application.cpp.

◆ ~Application()

~Application ( )

virtual

Destructor.

Definition at line 340 of file Application.cpp.

Member Function Documentation

◆ cancelExit()

void cancelExit ( )

static

Cancels a users requested exit (ALT-F4 or X button)

Definition at line 126 of file Application.cpp.

◆ display()

virtual void display ( )

pure virtual

Display.

Implemented in TDMEEditor, ConvertToTMApplication, ImportTModelApplication, RecreateVKCacheApplication, and Installer.

◆ displayInternal()

void displayInternal ( )

staticprivate

Display function.

Definition at line 728 of file Application.cpp.

◆ dispose()

virtual void dispose ( )

pure virtual

Disposes.

Implemented in TDMEEditor, ConvertToTMApplication, ImportTModelApplication, RecreateVKCacheApplication, and Installer.

◆ execute()

string execute ( const string & command )

static

Execute a command and wait until it finished running.

Parameters

command command to execute

Exceptions

std::runtime_error

Returns: application output

Definition at line 91 of file Application.cpp.

◆ executeBackground()

void executeBackground ( const string & command )

static

Execute a command in background.

Parameters

command command to execute

Definition at line 108 of file Application.cpp.

◆ exit()

void exit ( int exitCode )

static

Exits this application with given exit code.

Parameters

exitCode exit code

Definition at line 130 of file Application.cpp.

◆ getApplication()

static Application * getApplication ( )

inlinestatic

Returns: application

Definition at line 68 of file Application.h.

◆ getClipboardContent()

string getClipboardContent ( )

Returns: clipboard content as utf8 string

Definition at line 515 of file Application.cpp.

◆ getCPUName()

string getCPUName ( )

static

Returns: CPU the application is running on

Definition at line 372 of file Application.cpp.

◆ getExecutableFileName()

const string & getExecutableFileName ( )

inline

Returns: executable file name

Definition at line 123 of file Application.h.

◆ getMousePositionX()

int getMousePositionX ( )

static

Returns: get mouse X position

Definition at line 485 of file Application.cpp.

◆ getMousePositionY()

int getMousePositionY ( )

static

Returns: get mouse Y position

Definition at line 491 of file Application.cpp.

◆ getOSName()

string getOSName ( )

static

Returns: Operating system the application is running on

Definition at line 350 of file Application.cpp.

◆ getRenderer()

static Renderer * getRenderer ( )

inlinestatic

Returns: renderer

Definition at line 54 of file Application.h.

◆ getTitle()

const string & getTitle ( )

inline

Returns: title

Definition at line 116 of file Application.h.

◆ getWindowHeight()

int getWindowHeight ( ) const

Returns: window height

Definition at line 429 of file Application.cpp.

◆ getWindowWidth()

int getWindowWidth ( ) const

Returns: window width

Definition at line 418 of file Application.cpp.

◆ getWindowXPosition()

int getWindowXPosition ( ) const

Returns: window X position

Definition at line 402 of file Application.cpp.

◆ getWindowYPosition()

int getWindowYPosition ( ) const

Returns: window Y position

Definition at line 410 of file Application.cpp.

◆ glfwOnChar()

void glfwOnChar	(	GLFWwindow *	window,
		unsigned int	key
	)

staticprivate

GLFW on char.

Parameters

window	window
key	key

Definition at line 753 of file Application.cpp.

◆ glfwOnClose()

void glfwOnClose ( GLFWwindow * window )

staticprivate

GLFW on close.

Definition at line 824 of file Application.cpp.

◆ glfwOnKey()

void glfwOnKey	(	GLFWwindow *	window,
		int	key,
		int	scanCode,
		int	action,
		int	mods
	)

staticprivate

GLFW on key.

Parameters

window	window
key	key
scanCode	scan code
action	action
mods	modifier keys

Definition at line 760 of file Application.cpp.

◆ glfwOnMouseButton()

void glfwOnMouseButton	(	GLFWwindow *	window,
		int	button,
		int	action,
		int	mods
	)

staticprivate

GLFW on key.

Parameters

window	window
button	button
action	action
mods	modifier keys

Definition at line 799 of file Application.cpp.

◆ glfwOnMouseMoved()

void glfwOnMouseMoved	(	GLFWwindow *	window,
		double	x,
		double	y
	)

staticprivate

GLFW on mouse moved.

Parameters

window	window
x	x
y	y

Definition at line 790 of file Application.cpp.

◆ glfwOnMouseWheel()

void glfwOnMouseWheel	(	GLFWwindow *	window,
		double	x,
		double	y
	)

staticprivate

GLFW on key.

Parameters

window	window
x	x
y	y

Definition at line 812 of file Application.cpp.

◆ glfwOnWindowResize()

void glfwOnWindowResize	(	GLFWwindow *	window,
		int	width,
		int	height
	)

staticprivate

GLFW on window resize.

Parameters

window	window
width	width
height	height

Definition at line 820 of file Application.cpp.

◆ hasApplication()

static bool hasApplication ( )

inlinestatic

Returns: if having a GL/Vulkan window and context

Definition at line 61 of file Application.h.

◆ initialize()

virtual void initialize ( )

pure virtual

Init.

Implemented in TDMEEditor, ConvertToTMApplication, ImportTModelApplication, RecreateVKCacheApplication, and Installer.

◆ installExceptionHandler()

void installExceptionHandler ( )

static

Windows only: Install exception handler that will print a stack trace if crashing.

Definition at line 464 of file Application.cpp.

◆ isActive()

bool isActive ( )

static

Returns: If window is active on Win32, on other platforms it currently always return true

Definition at line 394 of file Application.cpp.

◆ isDebuggingEnabled()

bool isDebuggingEnabled ( )

inline

Returns: debugging enabled

Definition at line 130 of file Application.h.

◆ isFullScreen()

bool isFullScreen ( ) const

Returns: is full screen

Definition at line 440 of file Application.cpp.

◆ isLimitFPS()

static bool isLimitFPS ( )

inlinestatic

Returns: if FPS should be limited to 60 frames per seconds

Definition at line 75 of file Application.h.

◆ onClose()

void onClose ( )

virtual

On close.

Reimplemented in Installer.

Definition at line 828 of file Application.cpp.

◆ openBrowser()

void openBrowser ( const string & url )

static

Open browser with given url.

Parameters

url url

Definition at line 116 of file Application.cpp.

◆ reshape()

virtual void reshape	(	int	width,
		int	height
	)

pure virtual

Resize.

Parameters

width	width
height	height

Implemented in TDMEEditor, and Installer.

◆ reshapeInternal()

void reshapeInternal	(	int	width,
		int	height
	)

staticprivate

Reshape function.

Parameters

width	width
height	height

Definition at line 745 of file Application.cpp.

◆ run()

void run	(	int	argc,
		char **	argv,
		const string &	title,
		InputEventHandler *	inputEventHandler = `nullptr`,
		int	windowHints = `WINDOW_HINT_NONE`
	)

Run this application.

Parameters

argc	argument count
argv	argument values
title	title
inputEventHandler	application input event handler
windowHints	window hints

Definition at line 527 of file Application.cpp.

◆ setClipboardContent()

void setClipboardContent ( const string & content )

Set clipboard content.

Parameters

content content

Definition at line 519 of file Application.cpp.

◆ setFullScreen()

void setFullScreen ( bool fullScreen )

Set full screen mode.

Parameters

fullScreen full screen

Definition at line 444 of file Application.cpp.

◆ setIcon()

void setIcon ( )

private

Set application icon.

Definition at line 701 of file Application.cpp.

◆ setInputEventHandler()

void setInputEventHandler ( InputEventHandler * inputEventHandler )

Set input event handler.

Parameters

inputEventHandler input event handler

Definition at line 390 of file Application.cpp.

◆ setLimitFPS()

static void setLimitFPS ( bool limitFPS )

inlinestatic

Set frames per seconds limit.

Parameters

limitFPS set up if FPS should be limited to 60 frames per seconds

Definition at line 83 of file Application.h.

◆ setMouseCursor()

void setMouseCursor ( int mouseCursor )

static

Set mouse cursor.

Parameters

mouseCursor mouse cursor, see MOUSE_CURSOR_*

Definition at line 470 of file Application.cpp.

◆ setMousePosition()

void setMousePosition	(	int	x,
		int	y
	)

static

Set mouse position.

Parameters

x	x
y	y

Definition at line 497 of file Application.cpp.

◆ setVSyncEnabled()

void setVSyncEnabled ( bool vSync )

static

Set vsync enabled.

Parameters

vSync vertical sync

Definition at line 343 of file Application.cpp.

◆ setWindowHeight()

void setWindowHeight ( int windowHeight )

Set window height.

Parameters

windowHeight window height

Definition at line 433 of file Application.cpp.

◆ setWindowWidth()

void setWindowWidth ( int windowWidth )

Set window width.

Parameters

windowWidth window width

Definition at line 422 of file Application.cpp.

◆ setWindowXPosition()

void setWindowXPosition ( int windowXPosition )

Set window X position when initializing.

Parameters

windowXPosition window X position

Definition at line 406 of file Application.cpp.

◆ setWindowYPosition()

void setWindowYPosition ( int windowYPosition )

Set window Y position when initializing.

Parameters

windowYPosition window Y position

Definition at line 414 of file Application.cpp.

◆ swapBuffers()

void swapBuffers ( )

static

Swap rendering buffers.

Definition at line 511 of file Application.cpp.

Friends And Related Function Documentation

◆ InputEventHandler

friend class InputEventHandler

friend

Definition at line 38 of file Application.h.

◆ tdme::engine::subsystems::renderer::VKRenderer

friend class tdme::engine::subsystems::renderer::VKRenderer

friend

Definition at line 39 of file Application.h.

Member Data Documentation

◆ application

Application * application = nullptr

staticprivate

Definition at line 314 of file Application.h.

◆ debuggingEnabled

bool debuggingEnabled { false }

private

Definition at line 318 of file Application.h.

◆ executableFileName

string executableFileName

private

Definition at line 317 of file Application.h.

◆ exitCode

int exitCode { 0 }

private

Definition at line 328 of file Application.h.

◆ FPS

constexpr int FPS { 60 }

staticconstexpr

Definition at line 49 of file Application.h.

◆ fullScreen

bool fullScreen { false }

private

Definition at line 324 of file Application.h.

◆ glfwCapsLockEnabled

bool glfwCapsLockEnabled = false

staticprivate

Definition at line 333 of file Application.h.

◆ glfwHandCursor

GLFWcursor * glfwHandCursor = nullptr

staticprivate

Definition at line 334 of file Application.h.

◆ glfwMouseButtonDownFrames

array< unsigned int, 10 > glfwMouseButtonDownFrames

staticprivate

Definition at line 331 of file Application.h.

◆ glfwMouseButtonLast

int glfwMouseButtonLast = -1

staticprivate

Definition at line 332 of file Application.h.

◆ glfwWindow

GLFWwindow * glfwWindow = nullptr

staticprivate

Definition at line 330 of file Application.h.

◆ initialized

bool initialized { false }

private

Definition at line 319 of file Application.h.

◆ inputEventHandler

InputEventHandler * inputEventHandler = nullptr

staticprivate

Definition at line 315 of file Application.h.

◆ limitFPS

bool limitFPS = true

staticprivate

Definition at line 326 of file Application.h.

◆ renderer

Renderer * renderer = nullptr

staticprivate

Definition at line 313 of file Application.h.

◆ timeLast

int64_t timeLast = -1L

staticprivate

Definition at line 325 of file Application.h.

◆ title

string title

private

Definition at line 327 of file Application.h.

◆ WINDOW_HINT_INVISIBLE

constexpr int WINDOW_HINT_INVISIBLE { 4 }

staticconstexpr

Definition at line 46 of file Application.h.

◆ WINDOW_HINT_MAXIMIZED

constexpr int WINDOW_HINT_MAXIMIZED { 8 }

staticconstexpr

Definition at line 47 of file Application.h.

◆ WINDOW_HINT_NONE

constexpr int WINDOW_HINT_NONE { 0 }

staticconstexpr

Definition at line 43 of file Application.h.

◆ WINDOW_HINT_NOTDECORATED

constexpr int WINDOW_HINT_NOTDECORATED { 2 }

staticconstexpr

Definition at line 45 of file Application.h.

◆ WINDOW_HINT_NOTRESIZEABLE

constexpr int WINDOW_HINT_NOTRESIZEABLE { 1 }

staticconstexpr

Definition at line 44 of file Application.h.

◆ windowHeight

int windowHeight { 768 }

private

Definition at line 321 of file Application.h.

◆ windowHints

int windowHints { WINDOW_HINT_NONE }

private

Definition at line 316 of file Application.h.

◆ windowWidth

int windowWidth { 1024 }

private

Definition at line 320 of file Application.h.

◆ windowXPosition

int windowXPosition { -1 }

private

Definition at line 322 of file Application.h.

◆ windowYPosition

int windowYPosition { -1 }

private

Definition at line 323 of file Application.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/application/Application.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/application/Application.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Application()

◆ ~Application()

Member Function Documentation

◆ cancelExit()

◆ display()

◆ displayInternal()

◆ dispose()

◆ execute()

◆ executeBackground()

◆ exit()

◆ getApplication()

◆ getClipboardContent()

◆ getCPUName()

◆ getExecutableFileName()

◆ getMousePositionX()

◆ getMousePositionY()

◆ getOSName()

◆ getRenderer()

◆ getTitle()

◆ getWindowHeight()

◆ getWindowWidth()

◆ getWindowXPosition()

◆ getWindowYPosition()

◆ glfwOnChar()

◆ glfwOnClose()

◆ glfwOnKey()

◆ glfwOnMouseButton()

◆ glfwOnMouseMoved()

◆ glfwOnMouseWheel()

◆ glfwOnWindowResize()

◆ hasApplication()

◆ initialize()

◆ installExceptionHandler()

◆ isActive()

◆ isDebuggingEnabled()

◆ isFullScreen()

◆ isLimitFPS()

◆ onClose()

◆ openBrowser()

◆ reshape()

◆ reshapeInternal()

◆ run()

◆ setClipboardContent()

◆ setFullScreen()

◆ setIcon()

◆ setInputEventHandler()

◆ setLimitFPS()

◆ setMouseCursor()

◆ setMousePosition()

◆ setVSyncEnabled()

◆ setWindowHeight()

◆ setWindowWidth()

◆ setWindowXPosition()

◆ setWindowYPosition()

◆ swapBuffers()

Friends And Related Function Documentation

◆ InputEventHandler

◆ tdme::engine::subsystems::renderer::VKRenderer

Member Data Documentation

◆ application

◆ debuggingEnabled

◆ executableFileName

◆ exitCode

◆ FPS

◆ fullScreen

◆ glfwCapsLockEnabled

◆ glfwHandCursor

◆ glfwMouseButtonDownFrames

◆ glfwMouseButtonLast

◆ glfwWindow