#include <VE_Instance.h>

Public Member Functions
	VE_Instance ()=default

void	destroy ()

VkInstance	handle () const

VE_VulkanAPIVersion	apiVersion () const

uint32_t	apiVersionNumber () const
	The more opaque form of the api version that is used for Vulkan API calls. More...

bool	extensionEnabled (VE_InstanceExtension ext) const

bool	extensionEnabled (const char *ext) const

const UT_ArrayStringSet &	enabledExtensions () const

VE_Result< UT_Array < VE_PhysicalDevice > >	physicalDevices () const

Static Public Member Functions
static VE_Result< VE_Instance >	create (VE_VulkanAPIVersion version, uint32_t extension_count=0, const char *const extension_names[]=nullptr)

static VE_Result< VE_Instance >	create (VE_VulkanAPIVersion version, uint32_t extension_count, const VE_InstanceExtension extensions[])

Detailed Description

Low level wrapper around a VkInstance. Users must be explicit call destroy() when done with this.

Definition at line 68 of file VE_Instance.h.

Constructor & Destructor Documentation

VE_Instance::VE_Instance ( )

default

Member Function Documentation

VE_VulkanAPIVersion VE_Instance::apiVersion ( ) const

inline

Definition at line 100 of file VE_Instance.h.

uint32_t VE_Instance::apiVersionNumber ( ) const

The more opaque form of the api version that is used for Vulkan API calls.

static VE_Result<VE_Instance> VE_Instance::create	(	VE_VulkanAPIVersion	version,
		uint32_t	extension_count = `0`,
		const char *const	extension_names[] = `nullptr`
	)

static

static VE_Result<VE_Instance> VE_Instance::create	(	VE_VulkanAPIVersion	version,
		uint32_t	extension_count,
		const VE_InstanceExtension	extensions[]
	)

static

void VE_Instance::destroy ( )

Destroys the underlying vulkan instance. Must not be called until all VkDevice objects that this was used to create have been destroyed.

const UT_ArrayStringSet& VE_Instance::enabledExtensions ( ) const

inline

Definition at line 108 of file VE_Instance.h.

bool VE_Instance::extensionEnabled ( VE_InstanceExtension ext ) const

bool VE_Instance::extensionEnabled ( const char * ext ) const

inline

Definition at line 106 of file VE_Instance.h.

VkInstance VE_Instance::handle ( ) const

inline

Definition at line 98 of file VE_Instance.h.

VE_Result<UT_Array<VE_PhysicalDevice> > VE_Instance::physicalDevices ( ) const

Returns a list of physical devices (such as GPUs) avaiable to the instance. The list can be scanned for a suitable physical device, which can then be used to create logical device objects.

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

VE/VE_Instance.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation