atomic::render::vkLib::VulkanInstance Class Reference

Creates a Vulkan instance and destroys it. More...

#include <vkInit.h>

Public Member Functions
	VulkanInstance (const char *app_name, int app_version, int engine_version, bool isVR=false)
	Creates the object and initialises the Vulkan instance. Stores a private pointer in the object.
	~VulkanInstance ()
	Destroys the object, sets VKinstance to nullptr and destroys the Vulkan instance.

Private Attributes
const vk::Instance *	VKinstance
std::vector< const char * >	layers
std::vector< const char * >	availableExtensions

Detailed Description

Creates a Vulkan instance and destroys it.

This class is basically a fancy wrapper around the vk::Instance class. It is only used to create a Vulkan instance (and to destroy it) along with enabling validation layers if necessary and gathering extensions.

Author

Equalisys

Version

1.0.0

Constructor & Destructor Documentation

VulkanInstance()

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

Creates the object and initialises the Vulkan instance. Stores a private pointer in the object.

Parameters

app_name	The name of the application
app_version	The version of the application
engine_version	The version of the engine
isVR	Whether or not the application is a VR application. This is not used yet, but it will be in the future.

~VulkanInstance()

atomic::render::vkLib::VulkanInstance::~VulkanInstance

(

)

Destroys the object, sets VKinstance to nullptr and destroys the Vulkan instance.

This function is called when the object is destroyed. It cleans up the Vulkan instance and sets the private pointer to the previous VKInstance to nullptr.

---

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

• vkInit.h
• vkInit.cpp