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::event(e);
    }

   voidrender() {
       // ...
       requestUpdate();// 連続的にレンダリング
    }

private:
    boolm_initialized= false;
};

intmain(intargc, char**argv)
{
    QGuiApplication app(argc,argv);

    QVulkanInstance inst;
    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のバージョンを返します。ただし、create() の呼び出し前にsetApiVersion() が呼び出されていなかった場合は、バージョン番号として null を返します。

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

[since 6.5] void QVulkanInstance::clearDebugOutputFilters()

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

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

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

bool QVulkanInstance::create()

Vulkan ライブラリを初期化し、新しい 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も破棄します。QVulkanInstance オブジェクトは、create()を再度呼び出すことで引き続き再利用可能です。

QVulkanDeviceFunctions *QVulkanInstance::deviceFunctions(VkDevice device)

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

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

デバイスレベルの関数を除き、Vulkanのコアコマンドセットを公開し、クロスプラットフォームでの動作が保証されている、対応するQVulkanFunctions オブジェクトを返します。

Vulkan 1.0 コア API の関数は常に利用可能です。 1.1 や 1.2 などのより新しい Vulkan バージョンに関しては、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)

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 ハンドルを採用するようにします。

Qtには、すでに作成済みのVkInstanceに対してレイヤーや拡張機能を有効にする手段はありません。 したがって、existingVkInstance がQtでの使用に適していることを確認するのは、呼び出し側の責任となります。QRhi ベースのレンダリングが関与する場合は、QRhiVulkanInitParams::preferredInstanceExtensions()を呼び出して、上記で言及した拡張機能に加えて、実行時にシステムで利用可能かつサポートされている限り、existingVkInstance の生成者が有効にするべきインスタンス拡張機能の追加リストを照会してください。

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