QVulkanFunctions Class

The QVulkanFunctions class provides cross-platform access to the instance level core Vulkan 1.0 API. More...

Header:	#include <QVulkanFunctions>
qmake:	QT += gui
Since:	Qt 5.10

• List of all members, including inherited members

Public Functions

	~QVulkanFunctions()
int	vkCreateDevice(int, const int *, const int *, int *)
int	vkEnumerateDeviceExtensionProperties(int, const char *, uint32_t *, int *)
int	vkEnumerateDeviceLayerProperties(int, uint32_t *, int *)
int	vkEnumerateInstanceExtensionProperties(const char *, uint32_t *, int *)
int	vkEnumerateInstanceLayerProperties(uint32_t *, int *)
int	vkEnumeratePhysicalDevices(int, uint32_t *, int *)
int	vkGetDeviceProcAddr(int, const char *)
void	vkGetPhysicalDeviceFeatures(int physicalDevice, int *pFeatures)
void	vkGetPhysicalDeviceFormatProperties(int physicalDevice, int format, int *pFormatProperties)
int	vkGetPhysicalDeviceImageFormatProperties(int, int, int, int, int, int, int *)
void	vkGetPhysicalDeviceMemoryProperties(int physicalDevice, int *pMemoryProperties)
void	vkGetPhysicalDeviceProperties(int physicalDevice, int *pProperties)
void	vkGetPhysicalDeviceQueueFamilyProperties(int physicalDevice, uint32_t *pQueueFamilyPropertyCount, int *pQueueFamilyProperties)
void	vkGetPhysicalDeviceSparseImageFormatProperties(int physicalDevice, int format, int type, int samples, int usage, int tiling, uint32_t *pPropertyCount, int *pProperties)

Detailed Description

The QVulkanFunctions class provides cross-platform access to the instance level core Vulkan 1.0 API.

Qt and Qt applications do not link to any Vulkan libraries by default. Instead, all functions are resolved dynamically at run time. Each QVulkanInstance provides a QVulkanFunctions object retrievable via QVulkanInstance::functions(). This does not contain device level functions in order to avoid the potential overhead of an internal dispatching. Instead, functions that rely on a device, or a dispatchable child object of a device, are exposed via QVulkanDeviceFunctions and QVulkanInstance::deviceFunctions(). QVulkanFunctions and QVulkanDeviceFunctions together provides access to the full core Vulkan API, excluding any extensions.

Note: QVulkanFunctions instances cannot be constructed directly.

The typical usage is the following:

    void Window::render()
    {
        QVulkanInstance *inst = vulkanInstance();
        QVulkanFunctions *f = inst->functions();
        ...
        VkResult err = f->vkAllocateCommandBuffers(device, &cmdBufInfo, &cmdBuf);
        ...
    }

Note: Windowing system interface (WSI) specifics and extensions are excluded. This class only covers core Vulkan commands, with the exception of instance creation, destruction, and function resolving, since such functionality is covered by QVulkanInstance itself.

To access additional functions, applications can use QVulkanInstance::getInstanceProcAddr() and vkGetDeviceProcAddr(). Applications can also decide to link to a Vulkan library directly, as platforms with an appropriate loader will typically export function symbols for the core commands. See the man page for vkGetInstanceProcAddr for more information.

See also QVulkanInstance, QVulkanDeviceFunctions, QWindow::setVulkanInstance(), and QWindow::setSurfaceType().

Member Function Documentation

QVulkanFunctions::~QVulkanFunctions()

Destroys the instance of QVulkanFunctions.

int QVulkanFunctions::vkCreateDevice(int, const int *, const int *, int *)

int QVulkanFunctions::vkEnumerateDeviceExtensionProperties(int, const char *, uint32_t *, int *)

int QVulkanFunctions::vkEnumerateDeviceLayerProperties(int, uint32_t *, int *)

int QVulkanFunctions::vkEnumerateInstanceExtensionProperties(const char *, uint32_t *, int *)

int QVulkanFunctions::vkEnumerateInstanceLayerProperties(uint32_t *, int *)

int QVulkanFunctions::vkEnumeratePhysicalDevices(int, uint32_t *, int *)

int QVulkanFunctions::vkGetDeviceProcAddr(int, const char *)

void QVulkanFunctions::vkGetPhysicalDeviceFeatures(int physicalDevice, int *pFeatures)

void QVulkanFunctions::vkGetPhysicalDeviceFormatProperties(int physicalDevice, int format, int *pFormatProperties)

int QVulkanFunctions::vkGetPhysicalDeviceImageFormatProperties(int, int, int, int, int, int, int *)

void QVulkanFunctions::vkGetPhysicalDeviceMemoryProperties(int physicalDevice, int *pMemoryProperties)

void QVulkanFunctions::vkGetPhysicalDeviceProperties(int physicalDevice, int *pProperties)

void QVulkanFunctions::vkGetPhysicalDeviceQueueFamilyProperties(int physicalDevice, uint32_t *pQueueFamilyPropertyCount, int *pQueueFamilyProperties)

void QVulkanFunctions::vkGetPhysicalDeviceSparseImageFormatProperties(int physicalDevice, int format, int type, int samples, int usage, int tiling, uint32_t *pPropertyCount, int *pProperties)