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();
    // ...

class VulkanWindow : public QWindow
{
public:
    VulkanWindow() {
        setSurfaceType(VulkanSurface);
    }

    void exposeEvent(QExposeEvent *) {
        if (isExposed()) {
            if (!m_initialized) {
                m_initialized = true;
                // initialize device, swapchain, etc.
                QVulkanInstance *inst = vulkanInstance();
                QVulkanFunctions *f = inst->functions();
                uint32_t devCount = 0;
                f->vkEnumeratePhysicalDevices(inst->vkInstance(), &devCount, nullptr);
                // ...
                // build the first frame
                render();
            }
        }
    }

    bool event(QEvent *e) {
        if (e->type() == QEvent::UpdateRequest)
            render();
        return QWindow::event(e);
    }

    void render() {
       // ...
       requestUpdate(); // render continuously
    }

private:
    bool m_initialized = false;
};

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

    QVulkanInstance inst;
    if (!inst.create()) {
        qWarning("Vulkan not available");
        return 1;
    }

    VulkanWindow window;
    window.showMaximized();

    return app.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

create() の前にsetApiVersion() が呼び出されなかった場合、アプリケーションが実行を期待する要求された Vulkan API バージョン、または null バージョン番号を返します。

setApiVersion()も参照してください 。

[since 6.5] void QVulkanInstance::clearDebugOutputFilters()

installDebugOutputFilter() によって以前にインストールされたすべてのフィルター関数を削除します。

この関数は Qt 6.5 で導入されました。

installDebugOutputFilter()も参照してください 。

bool QVulkanInstance::create()

Vulkan ライブラリを初期化し、新規または既存の Vulkan インスタンスを作成します。

成功した場合はtrueを返し、エラーまたはVulkanがサポートされていない場合はfalseを返します。

成功した場合、このQVulkanInstance へのポインタはvkInstance() を介して取得可能です。

このQVulkanInstance が存在する限り、またはdestroy() が呼び出されるまで、Vulkan インスタンスとライブラリは利用可能です。

デフォルトでは、VkInstanceはフラグVK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHRが設定された状態で作成されます。これは、Vulkan Portability物理デバイスも列挙されることを意味します。これを望まない場合は、NoPortabilityDrivers フラグを設定します。

void QVulkanInstance::destroy()

基礎となるプラットフォームインスタンスを破棄し、VkInstanceを破棄します（所有されている場合）。create() を再度呼び出すことで、QVulkanInstance オブジェクトはまだ再利用可能です。

QVulkanDeviceFunctions *QVulkanInstance::deviceFunctions(VkDevice device)

デバイスレベルのコアVulkanコマンドセットを公開し、クロスプラットフォームで機能することが保証されたQVulkanDeviceFunctions オブジェクトを返します。

コアVulkan 1.0 APIからの関数は常に利用可能です。1.1や1.2のような、より高いVulkanバージョンになると、QVulkanDeviceFunctions オブジェクトはそれらのコアAPI関数も解決しようとしますが、実行時のVulkan物理デバイスがそれらをサポートしていない場合、そのようなサポートされていない関数を呼び出すと、指定されていない動作になります。1.0より高いVulkanバージョンのサポートを適切に有効にするには、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からの関数は常に利用可能です。1.1や1.2など、より高いVulkanバージョンになると、QVulkanFunctions オブジェクトは、それらのコアAPI関数も解決しようとしますが、実行時のVulkanインスタンス実装がそれらをサポートしていない場合、そのようなサポートされていない関数を呼び出すと、指定されていない動作になります。さらに、1.0より高いVulkanバージョンのサポートを適切に有効にするには、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)

Vulkanデバッグメッセージごとに呼び出されるfilter 関数をインストールします。コールバックがtrue を返すと、メッセージは停止され（フィルタリングされ）、デバッグ出力には表示されません。

この関数は Qt 6.5 で導入されました。

clearDebugOutputFilters()も参照してください 。

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

これはオーバーロードされた関数です。

Vulkanデバッグメッセージごとに呼び出されるfilter 関数をインストールします。コールバックが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)

指定されたdevice のQVulkanDeviceFunctions オブジェクトを無効にして破棄します。

この関数は、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 ハンドルを採用します。

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()も参照してください 。