VE_PhysicalDevice Class Reference

#include <VE_PhysicalDevice.h>

Public Member Functions
VkPhysicalDevice	getVkPhysicalDevice () const
const VkPhysicalDeviceProperties &	properties () const
const VkPhysicalDeviceIDProperties &	idProperties () const
const VkPhysicalDeviceVulkan11Properties &	vulkan11Properties () const
const VkPhysicalDeviceVulkan12Properties &	vulkan12Properties () const
const VkPhysicalDeviceAccelerationStructurePropertiesKHR &	accelStructProperties () const
const VE_PhysicalDeviceFeatureChain &	features () const
bool	extensionAvailable (const char *name) const
bool	extensionAvailable (VE_DeviceExtension ext) const
const UT_Array < VkQueueFamilyProperties > &	queueFamiltyProperties () const
const VkPhysicalDeviceMemoryProperties &	memoryProperties () const
void	printInfo () const
UT_Optional< uint32_t >	findMemoryTypeIndex (uint32_t memory_type_bits, VkMemoryPropertyFlags required_properties) const
UT_Optional< uint32_t >	findMemoryTypeIndex (VkMemoryPropertyFlags flags) const
const UT_ArrayStringSet &	availableExtensions () const
UT_Optional< uint32_t >	findQueueFamilyIndex (VkQueueFlags flags) const
VkFormatProperties	formatProperties (const VkFormat format) const
VE_Result < VkImageFormatProperties2 >	imageFormatProperties (const VkImageCreateInfo &info) const
	VE_PhysicalDevice ()=default

Static Public Member Functions
static VE_Result < VE_PhysicalDevice >	create (VkPhysicalDevice)
static VE_Result< UT_Array < VE_PhysicalDevice > >	findAll (VkInstance instance)

Detailed Description

A wrapper around a VkPhysicalDevice object that also contains useful information about that physical device. Due to caching information from the driver, this object is rather hefty. Consider allocating it on the heap.

Definition at line 105 of file VE_PhysicalDevice.h.

Constructor & Destructor Documentation

VE_PhysicalDevice::VE_PhysicalDevice ( )

default

Member Function Documentation

const VkPhysicalDeviceAccelerationStructurePropertiesKHR& VE_PhysicalDevice::accelStructProperties ( ) const

inline

Definition at line 136 of file VE_PhysicalDevice.h.

const UT_ArrayStringSet& VE_PhysicalDevice::availableExtensions ( ) const

inline

Definition at line 197 of file VE_PhysicalDevice.h.

static VE_Result<VE_PhysicalDevice> VE_PhysicalDevice::create ( VkPhysicalDevice  )

static

bool VE_PhysicalDevice::extensionAvailable

(

const char *

name

)

const

bool VE_PhysicalDevice::extensionAvailable

(

VE_DeviceExtension

ext

)

const

const VE_PhysicalDeviceFeatureChain& VE_PhysicalDevice::features ( ) const

inline

Definition at line 141 of file VE_PhysicalDevice.h.

static VE_Result<UT_Array<VE_PhysicalDevice> > VE_PhysicalDevice::findAll ( VkInstance  instance )

static

UT_Optional<uint32_t> VE_PhysicalDevice::findMemoryTypeIndex	(	uint32_t	memory_type_bits,
		VkMemoryPropertyFlags	required_properties
	)		const

Methods for retrieving a memory type index.

Vulkan resources can be created before any memory is actually allocated for them. This memory-less resource handle acts as a kind of meta-data object. One of the reasons for this is so the memory requirements for the resource can be queried before the resource is actually allocated, allowing us to merge the resources requirements with the applications needs and preferences.

The resource's requirements are expressed as memory type bits. The applications requirements or preferences are expressed as VkMemoryPropertyFlags. You can pass both of these to these new methods to retrieve the actually memory type index, which is all you need to actually allocate the memory.

Usage:

VkMemoryRequirements reqs;

vkGetBufferMemoryRequirements(device, buffer, &reqs);

uint32_t memory_type_index;

auto r = physical_device.findMemoryTypeIndex(reqs.memoryTypeBits,
        preferred_flags | required_flags);
if (!r)
    r = physical_device.findMemoryTypeIndex(reqs.memoryTypeBits,
        required_flags);

memory_type_index = *r;

UT_Optional<uint32_t> VE_PhysicalDevice::findMemoryTypeIndex

(

VkMemoryPropertyFlags

flags

)

const

Returns the memory type index satisfying the given flags, or none. This is equivalent to the above call with memory_type_bits == 0xFFFFFFFF

UT_Optional<uint32_t> VE_PhysicalDevice::findQueueFamilyIndex

(

VkQueueFlags

flags

)

const

VkFormatProperties VE_PhysicalDevice::formatProperties

(

const VkFormat

format

)

const

VkPhysicalDevice VE_PhysicalDevice::getVkPhysicalDevice ( ) const

inline

Definition at line 112 of file VE_PhysicalDevice.h.

const VkPhysicalDeviceIDProperties& VE_PhysicalDevice::idProperties ( ) const

inline

Definition at line 119 of file VE_PhysicalDevice.h.

VE_Result<VkImageFormatProperties2> VE_PhysicalDevice::imageFormatProperties

(

const VkImageCreateInfo &

info

)

const

const VkPhysicalDeviceMemoryProperties& VE_PhysicalDevice::memoryProperties ( ) const

inline

Definition at line 151 of file VE_PhysicalDevice.h.

void VE_PhysicalDevice::printInfo

(

)

const

const VkPhysicalDeviceProperties& VE_PhysicalDevice::properties ( ) const

inline

Definition at line 114 of file VE_PhysicalDevice.h.

const UT_Array<VkQueueFamilyProperties>& VE_PhysicalDevice::queueFamiltyProperties ( ) const

inline

Definition at line 146 of file VE_PhysicalDevice.h.

const VkPhysicalDeviceVulkan11Properties& VE_PhysicalDevice::vulkan11Properties ( ) const

inline

Definition at line 124 of file VE_PhysicalDevice.h.

const VkPhysicalDeviceVulkan12Properties& VE_PhysicalDevice::vulkan12Properties ( ) const

inline

Definition at line 130 of file VE_PhysicalDevice.h.

---

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

• VE/VE_PhysicalDevice.h