SimpleGL  1.1.0
A framework for platform independent rendering
Public Member Functions | List of all members
sgl::Instance Class Reference

This class wraps a Vulkan instance. More...

#include <vulkan_instance.hpp>

Public Member Functions

 Instance (bool debugMode=false)
 Creates a new Vulkan instance. More...
 
 ~Instance (void)
 Destroys the Vulkan instance. More...
 
VkInstance getHandle ()
 Returns the handle of the Vulkan instance. More...
 
PFN_vkVoidFunction getProcAddr (std::string name)
 Returns a function pointer for an instance function. More...
 
std::vector< VkPhysicalDevice > enumeratePhysicalDevices ()
 Enumerates the physical devices accessible to this instance. More...
 

Detailed Description

This class wraps a Vulkan instance.

Definition at line 25 of file vulkan_instance.hpp.

Constructor & Destructor Documentation

sgl::Instance::Instance ( bool  debugMode = false)

Creates a new Vulkan instance.

Parameters
debugModeIndicates if the instance should include debug layers and extensions, default is false.

Definition at line 19 of file vulkan_instance.cpp.

sgl::Instance::~Instance ( void  )

Destroys the Vulkan instance.

Definition at line 60 of file vulkan_instance.cpp.

Member Function Documentation

std::vector< VkPhysicalDevice > sgl::Instance::enumeratePhysicalDevices ( )

Enumerates the physical devices accessible to this instance.

Returns
A list of accessible physical devices.

Definition at line 73 of file vulkan_instance.cpp.

VkInstance sgl::Instance::getHandle ( )

Returns the handle of the Vulkan instance.

Returns
The handle of the Vulkan instance.

Definition at line 65 of file vulkan_instance.cpp.

PFN_vkVoidFunction sgl::Instance::getProcAddr ( std::string  name)

Returns a function pointer for an instance function.

This is only necessary for extension functions.

Parameters
nameThe name of the function.
Returns
A function pointer for the instance function.

Definition at line 69 of file vulkan_instance.cpp.


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