atlas::vk::vk_physical_driver Class Reference

vulkan-specific implementation wrapper around VkPhysicalDevice More...

#include <vk_physical_driver.hpp>

Public Member Functions
	vk_physical_driver (const VkInstance &p_instance)
	constructs a new vulkan physical device
queue_family_indices	read_queue_family_indices () const
	gives you the queue families that are supported
VkPhysicalDeviceMemoryProperties	memory_properties () const
uint32_t	read_presentation_index (const VkSurfaceKHR &p_surface)
surface_properties	get_surface_properties (const VkSurfaceKHR &p_surface)
	querying surface properties based on the currently specified VkSurfaceKHR handle created
	operator VkPhysicalDevice ()
	Allows for treating vk_physical_device as a VkPhysicalDevice handle.
	operator VkPhysicalDevice () const
	Allows for treating vk_physical_device as a VkPhysicalDevice handle.

Detailed Description

vulkan-specific implementation wrapper around VkPhysicalDevice

Wrapper that constructs a single physical device that provides API's that can be used to query specific information for your specific physical device

A physical device represents your current hardware GPU and allows for the ability to enumerate information to check for compatibility on the current GPU

Constructor & Destructor Documentation

vk_physical_driver()

atlas::vk::vk_physical_driver::vk_physical_driver

(

const VkInstance &

p_instance

)

constructs a new vulkan physical device

Parameters

p_instance

requires a VkInstance to create a VkPhysicalDevice handle

Member Function Documentation

operator VkPhysicalDevice() [1/2]

atlas::vk::vk_physical_driver::operator VkPhysicalDevice ( )

inline

Allows for treating vk_physical_device as a VkPhysicalDevice handle.

Simplifies using this same class for creating other vulkan metaobjects

operator VkPhysicalDevice() [2/2]

atlas::vk::vk_physical_driver::operator VkPhysicalDevice ( ) const

inline

Allows for treating vk_physical_device as a VkPhysicalDevice handle.

Simplifies using this same class for creating other vulkan metaobjects

read_presentation_index()

uint32_t atlas::vk::vk_physical_driver::read_presentation_index

(

const VkSurfaceKHR &

p_surface

)

Returns

uint32_t is the index to the presentation index of the specific presentation queue

read_queue_family_indices()

queue_family_indices atlas::vk::vk_physical_driver::read_queue_family_indices ( ) const

inline

gives you the queue families that are supported

Returns

queue_family_indices are the indices of the specific queue's that are compatible on current hardware specifications

---

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

• TheAtlasEngine/atlas/drivers/vulkan-cpp/vk_physical_driver.hpp