atomic::render::Renderer Class Reference

Class responsible for initialising the rendering process. More...

#include <render.h>

Public Member Functions
	Renderer (const char *app_name, int app_version, int engine_version, bool isVR, bool resizable)
	Renderer class constructor.
	~Renderer ()
	Renderer object destructor.
void	startRenderLoop ()
	Starts main rendering loop.

Private Member Functions
GLFWwindow *	initWindow (const char *app_name)
	Initialises the GLFW window.

Private Attributes
GLFWwindow *	window = nullptr
bool	resizable = false

Detailed Description

Class responsible for initialising the rendering process.

This class is responsible for creating a window using GLFW and setting up the Vulkan instance with a call to vkInit) as well as managing the main game loop.

Author

Equalisys

Version

1.0.0

Constructor & Destructor Documentation

Renderer()

atomic::render::Renderer::Renderer	(	const char *	app_name,
		int	app_version,
		int	engine_version,
		bool	isVR = false,
		bool	resizable = false )

Renderer class constructor.

Will also call initWindow() and initialise the Vulkan instance

Parameters

app_name	Application name(
app_version	Application version
engine_version	Engine version
isVR	Indicates if app is VR-Readys
resizable	Indicates if window is resisable

See also

VulkanInstance class (vkInit.cpp)

Member Function Documentation

initWindow()

GLFWwindow * atomic::render::Renderer::initWindow ( const char * app_name )

private

Initialises the GLFW window.

Parameters

[in]

app_name

Name of the application (for the window title).

Returns

Pointer to the created GLFW window.

startRenderLoop()

void atomic::render::Renderer::startRenderLoop

(

)

Starts main rendering loop.

This function will poll for events from the window manager and will keep the window open until it receives a glfwWindowShouldClose() event (that can be created by the player by pressing the quit btn)

Parameters

window

Pointer to the GLFW window object

---

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

• render.h
• render.cpp