QVulkanInstance Class

    int main(int argc, char **argv)
    {
        QGuiApplication app(argc, argv);

        QVulkanInstance inst;
        if (!inst.create())
            return 1;

        // ...
        window->setVulkanInstance(&inst);
        window->show();

        return app.exec();
    }

    QVulkanInstance inst;

    // Enable validation layer, if supported. Messages go to qDebug by default.
    inst.setLayers({ "VK_LAYER_KHRONOS_validation" });

    bool ok = inst.create();
    if (!ok) {
        // ... Vulkan not available
    }

    if (!inst.layers().contains("VK_LAYER_KHRONOS_validation")) {
        // ... validation layer not available
    }

    QVulkanInstance inst;

    if (inst.supportedLayers().contains("VK_LAYER_KHRONOS_validation")) {
        // ...
    }
    bool ok = inst.create();
    // ...

classVulkanWindow :publicQWindow
{public: VulkanWindow() { setSurfaceType(VulkanSurface); }voidexposeEvent(QExposeEvent*){if(isExposed()) {if(!m_initialized) { m_initialized= true;// 初始化设备、交换链等。                QVulkanInstance*inst =vulkanInstance()；                QVulkanFunctions*f =  inst->functions(); uint32_t devCount= 0; f->vkEnumeratePhysicalDevices(inst->vkInstance(), &devCount,nullptr);// ... // 构建第一帧render(); } }boolevent(）QEvent*e) {if(e->type()==QEvent::UpdateRequest) render();returnQWindow} }boolevent(*e) { if (e->type(== :UpdateRequest)::event(e); }voidrender() {// ...requestUpdate();//render continuously }private:boolm_initialized= false; };intmain(intargc, char **argv) { QGuiApplicationapp(argc,argv)；    QVulkanInstanceinst;if(!inst.create()) {        qWarning("Vulkan not available");
       return 1; } VulkanWindow window; window.showMaximized();returnapp.exec(); }

bool myDebugFilter(VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objectType, uint64_t object,
                   size_t location, int32_t messageCode, const char *pLayerPrefix, const char *pMessage)

std::function<bool(DebugMessageSeverityFlags severity, DebugMessageTypeFlags type, const void *message)>;

成员函数文档

QVulkanInstance::QVulkanInstance()

构造一个新实例。

[noexcept] QVulkanInstance::~QVulkanInstance()

销毁器。

QVersionNumber QVulkanInstance::apiVersion() const

返回请求的 Vulkan API 版本，如果setApiVersion() 在create() 之前未被调用，则返回空版本号。

另请参阅 setApiVersion()。

[since 6.5] void QVulkanInstance::clearDebugOutputFilters()

删除之前通过installDebugOutputFilter() 安装的所有过滤器功能。

此函数在 Qt 6.5 中引入。

另请参阅 installDebugOutputFilter()。

bool QVulkanInstance::create()

初始化 Vulkan 库，创建新的或采用现有的 Vulkan 实例。

成功时返回 true，出错或不支持 Vulkan 时返回 false。

成功后，可通过vkInstance() 检索指向QVulkanInstance 的指针。

只要该QVulkanInstance 存在，或在调用destroy() 之前，Vulkan 实例和库都是可用的。

默认情况下，创建VkInstance时会设置VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR标志。这意味着 Vulkan Portability 物理设备也会被枚举出来。如果不希望这样，请设置NoPortabilityDrivers 标志。

void QVulkanInstance::destroy()

销毁底层平台实例，从而销毁 VkInstance（当拥有时）。QVulkanInstance 对象仍可通过再次调用create() 重用。

QVulkanDeviceFunctions *QVulkanInstance::deviceFunctions(VkDevice device)

返回QVulkanDeviceFunctions 对象，该对象公开了设备级核心 Vulkan 命令集，并保证跨平台运行。

Vulkan 1.0 核心 API 中的函数将始终可用。当涉及到更高的 Vulkan 版本（如 1.1 和 1.2）时，QVulkanDeviceFunctions 对象也会尝试解析这些版本的核心 API 函数，但如果 Vulkan 物理设备在运行时不支持这些函数，调用任何此类不支持的函数都会导致不明行为。要正确启用对 Vulkan 1.0 以上版本的支持，可能需要在create() 之前调用setApiVersion() 来设置适当的实例 API 版本。此外，应用程序应在 VkPhysicalDeviceProperties 中检查物理设备的apiVersion 。

另请参阅 functions() 和resetDeviceFunctions()。

VkResult QVulkanInstance::errorCode() const

在create() 不成功后返回 Vulkan 错误代码，否则返回VK_SUCCESS 。

该值通常是 vkCreateInstance() 的返回值（当创建新的 Vulkan 实例而不是采用现有实例时），但如果平台插件不支持 Vulkan，该值也可能是VK_NOT_READY 。

QByteArrayList QVulkanInstance::extensions() const

如果调用create() 成功，则返回已启用的实例扩展名。否则返回请求的扩展名。

另请参见 setExtensions()。

QVulkanInstance::Flags QVulkanInstance::flags() const

返回请求的标志。

另请参见 setFlags()。

QVulkanFunctions *QVulkanInstance::functions() const

返回相应的QVulkanFunctions 对象，该对象公开核心 Vulkan 命令集（不包括设备级功能），并保证跨平台运行。

核心 Vulkan 1.0 API 中的函数将始终可用。当涉及更高的 Vulkan 版本（如 1.1 和 1.2）时，QVulkanFunctions 对象也会尝试解析这些版本的核心 API 函数，但如果运行时的 Vulkan 实例实现不支持这些函数，调用任何此类不支持的函数都会导致不明行为。此外，要正确启用对 Vulkan 1.0 以上版本的支持，可能需要在create() 之前调用setApiVersion() 来设置适当的实例 API 版本。要查询 Vulkan 实现的实例级版本，请调用supportedApiVersion() 。

另请参见 deviceFunctions() 和supportedApiVersion()。

PFN_vkVoidFunction QVulkanInstance::getInstanceProcAddr(const char *name)

使用给定的name 解析 Vulkan 函数。

对于核心 Vulkan 命令，最好使用从functions() 和deviceFunctions() 获取的函数封装器。

[since 6.5] void QVulkanInstance::installDebugOutputFilter(QVulkanInstance::DebugUtilsFilter filter)

安装一个filter 函数，调用该函数处理每一条 Vulkan 调试信息。当回调返回true 时，信息将被停止（过滤掉），不会出现在调试输出中。

此函数在 Qt 6.5 中引入。

另请参阅 clearDebugOutputFilters()。

void QVulkanInstance::installDebugOutputFilter(QVulkanInstance::DebugFilter filter)

这是一个重载函数。

安装一个filter 函数，每个 Vulkan 调试消息都会调用该函数。当回调返回true 时，信息将被停止（过滤掉），不会出现在调试输出中。

另请参阅 removeDebugOutputFilter()。

bool QVulkanInstance::isValid() const

如果create() 成功且实例有效，则返回 true。

QByteArrayList QVulkanInstance::layers() const

如果调用create() 成功，则返回已启用的实例图层。否则返回请求的图层。

另请参见 setLayers()。

void QVulkanInstance::presentAboutToBeQueued(QWindow *window)

应用程序的渲染器应在为window 的当前操作排队之前调用该函数。

在某些平台上，这将是一个无操作，而在某些平台上，可能会执行与窗口系统相关的同步。例如，在 Wayland 上，该函数将添加发送 wl_surface.frame 请求，以防止驱动程序阻塞最小化窗口。

void QVulkanInstance::presentQueued(QWindow *window)

应用程序的渲染器应在为window 进行呈现操作队列后调用该函数。

在某些平台上，这将是一个无操作，而在某些平台上，可能会执行与窗口系统相关的同步。例如，在 X11 上，该函数将更新_NET_WM_SYNC_REQUEST_COUNTER 。

void QVulkanInstance::removeDebugOutputFilter(QVulkanInstance::DebugFilter filter)

这是一个重载函数。

删除之前由installDebugOutputFilter() 安装的filter 函数。

另请参阅 installDebugOutputFilter()。

void QVulkanInstance::resetDeviceFunctions(VkDevice device)

使QVulkanDeviceFunctions 对象失效并销毁给定的device 。

当调用了deviceFunctions() 的 VkDevice 被销毁，而应用程序打算继续运行，并可能在稍后创建新的逻辑 Vulkan 设备时，必须调用此函数。

在销毁QVulkanInstance 之前无需调用该函数，因为随后会自动执行清理。

另请参见 deviceFunctions()。

void QVulkanInstance::setApiVersion(const QVersionNumber &vulkanVersion)

指定应用程序要使用的最高 Vulkan API 版本。

默认情况下，vulkanVersion 为 0，即 Vulkan 1.0。

建议应用程序开发人员熟悉Vulkan 规范中的apiVersion 注释。

另请参阅 apiVersion() 和supportedApiVersion()。

void QVulkanInstance::setExtensions(const QByteArrayList &extensions)

指定要启用的附加实例列表extensions 。指定不支持的扩展也是安全的，因为这些扩展在运行时不支持时会被忽略。

另请参阅 extensions()。

void QVulkanInstance::setFlags(QVulkanInstance::Flags flags)

根据提供的flags 配置create() 的行为。

另请参阅 flags()。

void QVulkanInstance::setLayers(const QByteArrayList &layers)

指定要启用的layers 实例列表。指定不支持的层也是安全的，因为这些层在运行时不支持时会被忽略。

另请参阅 layers()。

void QVulkanInstance::setVkInstance(VkInstance existingVkInstance)

使QVulkanInstance 采用现有的 VkInstance 句柄，而不是创建一个新句柄。

另请参阅 vkInstance()。

QVersionNumber QVulkanInstance::supportedApiVersion() const

返回 Vulkan 实现所支持的实例级功能的版本。

在实践中，如果 vkEnumerateInstanceVersion 函数可用（Vulkan 1.1 及更新版本），它要么是该函数返回的值，要么是 1.0。

如果应用程序希望根据运行时可用的 Vulkan 版本来分支其 Vulkan 功能和 API 的使用，则可以在调用create() 之前使用该函数来确定向setApiVersion() 传递的版本。

另请参见 setApiVersion()。

QVulkanInfoVector<QVulkanExtension> QVulkanInstance::supportedExtensions() const

返回受支持的实例级扩展的列表。

QVulkanInfoVector<QVulkanLayer> QVulkanInstance::supportedLayers() const

返回支持的实例层列表。

bool QVulkanInstance::supportsPresent(VkPhysicalDevice physicalDevice, uint32_t queueFamilyIndex, QWindow *window)

如果physicalDevice 中queueFamilyIndex 的队列族支持向window 呈现，则返回 true。

在检查给定 Vulkan 设备的队列时调用此函数，以决定哪个队列可用于执行呈现。

[static] VkSurfaceKHR QVulkanInstance::surfaceForWindow(QWindow *window)

为给定的window 创建或检索已有的VkSurfaceKHR 句柄。

如果失败，则返回 Vulkan 表面句柄或 0。

VkInstance QVulkanInstance::vkInstance() const

返回QVulkanInstance 封装的 VkInstance 句柄，如果create() 尚未被成功调用，且没有通过setVkInstance() 提供现存实例，则返回nullptr 。

另请参阅 setVkInstance()。