QVulkanWindow Class

メンバ関数ドキュメント

[explicit] QVulkanWindow::QVulkanWindow(QWindow *parent = nullptr)

与えられたparent で新しい QVulkanWindow を構築します。

表面タイプはQSurface::VulkanSurface に設定されます。

[virtual noexcept] QVulkanWindow::~QVulkanWindow()

デストラクタ。

QList<VkPhysicalDeviceProperties> QVulkanWindow::availablePhysicalDevices()

システムでサポートされている物理デバイスのプロパティのリストを返します。

QMatrix4x4 QVulkanWindow::clipCorrectionMatrix()

OpenGLとVulkan間の座標系の違いを補正するために使用できるQMatrix4x4 。

この行列で投影行列を事前乗算することで、アプリケーションは Y が上向きであると仮定し続けることができ、頂点 Z の位置をさらに補正することなく、ビューポートの minDepth と maxDepth をそれぞれ 0 と 1 に設定できます。OpenGLアプリケーションからのジオメトリは、OpenGLのカリングと前面設定に一致するラスタライズ状態を前提として、そのまま使用できます。

VkFormat QVulkanWindow::colorFormat() const

スワップチェーンが使用するカラーバッファ形式を返します。

setPreferredColorFormats()も参照 。

int QVulkanWindow::concurrentFrameCount() const

同時にアクティブになる可能性のあるフレーム数を返します。

    class Renderer {
        void startNextFrame();
        // ...

        VkDescriptorBufferInfo m_uniformBufInfo[QVulkanWindow::MAX_CONCURRENT_FRAME_COUNT];
        QVulkanWindow *m_window = nullptr;
    };

    void Renderer::startNextFrame()
    {
        const int count = m_window->concurrentFrameCount();
        // for (int i = 0; i < count; ++i)
            // m_uniformBufInfo[i] = ...
        // ...
    }

currentFrame()も参照 。

[virtual] QVulkanWindowRenderer *QVulkanWindow::createRenderer()

QVulkanWindowRenderer の新しいインスタンスを返す。

この仮想関数は、ウィンドウの有効期間中に一度だけ呼び出されます。

デフォルトの実装は null を返すため、バッファのクリア以外にレンダリングは行われません。

ウィンドウは返されたレンダラー オブジェクトの所有権を持ちます。

VkCommandBuffer QVulkanWindow::currentCommandBuffer() const

戻り値 現在のスワップチェーンイメージのアクティブなコマンドバッファ。QVulkanWindowRenderer::startNextFrame() の実装では、このコマンドバッファにコマンドが追加されます。

int QVulkanWindow::currentFrame() const

現在のフレームインデックスを [0,concurrentFrameCount() - 1] の範囲で返します。

レンダラの実装では、フレーム N が、まだアクティブなフレーム N - 1、N - 2、...によって使用されるデータを変更するのを防ぐために、均一なデータやその他の動的リソースが複数のコピーで存在するようにする必要があります。N -concurrentFrameCount() + 1。

動的な配列サイズに依存することを避けるため、アプリケーションは配列を宣言する際にMAX_CONCURRENT_FRAME_COUNT を使用することができます。これは、concurrentFrameCount （）から返される値と常に等しいか、それ以上であることが保証されている。このような配列は、この関数から返される値でインデックスを付けることができる。

    class Renderer {
        void startNextFrame();
        // ...

        VkDescriptorBufferInfo m_uniformBufInfo[QVulkanWindow::MAX_CONCURRENT_FRAME_COUNT];
        QVulkanWindow *m_window = nullptr;
    };

    void Renderer::startNextFrame()
    {
        VkDescriptorBufferInfo &uniformBufInfo(m_uniformBufInfo[m_window->currentFrame()]);
        // ...
    }

concurrentFrameCount()も参照 。

VkFramebuffer QVulkanWindow::currentFramebuffer() const

デフォルトのレンダーパスを使用して、現在のスワップチェーン画像の VkFramebuffer を返します。

フレームバッファは、マルチサンプリングが使用されていない場合は2つのアタッチメント（カラー、デプス-ステンシル）を持ち、sampleCountFlagBits() がVK_SAMPLE_COUNT_1_BIT より大きい場合は3つのアタッチメント（カラーリゾルブ、デプス-ステンシル、マルチサンプルカラー）を持ちます。 レンダラは、クリア値を提供する場合などに、これを考慮する必要があります。

defaultRenderPass()も参照 。

int QVulkanWindow::currentSwapChainImageIndex() const

0,swapChainImageCount() - 1] の範囲で、現在のスワップチェイン画像のインデックスを返す。

VkRenderPass QVulkanWindow::defaultRenderPass() const

1つのサブパスを持つ典型的なレンダーパスを返します。

currentFramebuffer()も参照 。

VkFormat QVulkanWindow::depthStencilFormat() const

depth-stencilバッファで使用されているフォーマットを返します。

VkImage QVulkanWindow::depthStencilImage() const

depth-stencil 画像を返します。

VkImageView QVulkanWindow::depthStencilImageView() const

depth-stencil 画像ビューを返します。

VkDevice QVulkanWindow::device() const

アクティブな論理デバイスを返します。

uint32_t QVulkanWindow::deviceLocalMemoryIndex() const

一般的な使用に適したデバイス・ローカル・メモリ・タイプ・インデックスを返します。

QVulkanWindow::Flags QVulkanWindow::flags() const

要求されたフラグを返す。

setFlags()も参照 。

[signal] void QVulkanWindow::frameGrabbed(const QImage &image)

このシグナルは、image の準備ができたときに発せられる。

void QVulkanWindow::frameReady()

この関数は、QVulkanWindowRenderer::startNextFrame （）実装を呼び出すたびに、1回だけ呼び出されなければならない。この関数が呼び出された時点で、currentCommandBuffer （）を介して公開されているメインコマンドバッファには、必要なすべてのレンダリングコマンドが追加されていなければなりません。

QVulkanWindowRenderer::startNextFrame()も参照してください 。

QImage QVulkanWindow::grab()

次のフレームを表示せずにビルドしてレンダリングし、画像コンテンツのブロッキングリードバックを実行します。

レンダラーのstartNextFrame() 実装がframeReady() を直接コールバックする場合は、画像を返す。そうでない場合は、サイズは正しいが内容はまだない、不完全な画像を返します。後者の場合、コンテンツはframeGrabbed() シグナルで配信されます。

返されるQImage のフォーマットは常にQImage::Format_RGBA8888 です。colorFormat() がVK_FORMAT_B8G8R8A8_UNORM の場合、赤と青のチャンネルは自動的に入れ替わります。このフォーマットは、スワップチェーンカラーバッファのデフォルトの選択として一般的に使用されているからです。その他のカラーバッファ形式では、この関数による変換は行われません。

VkCommandPool QVulkanWindow::graphicsCommandPool() const

アクティブなグラフィックス・コマンド・プールを返します。

VkQueue QVulkanWindow::graphicsQueue() const

アクティブなグラフィック・キューを返します。

uint32_t QVulkanWindow::graphicsQueueFamilyIndex() const

アクティブなグラフィック・キューのファミリ・インデックスを返します。

uint32_t QVulkanWindow::hostVisibleMemoryIndex() const

一般的な使用に適したホスト可視メモリタイプのインデックスを返します。

返されるメモリ型は、ホスト可視であり、かつコヒーレントです。また、可能であればキャッシュされます。

bool QVulkanWindow::isValid() const

このウィンドウがスワップチェーンを含むすべてのVulkanリソースの初期化に成功した場合、trueを返します。

VkImage QVulkanWindow::msaaColorImage(int idx) const

指定されたマルチサンプルカラーイメージ、またはマルチサンプリングが使用されていない場合はVK_NULL_HANDLE を返します。

idx は [0, () - 1] の範囲でなければなりません。swapChainImageCount

VkImageView QVulkanWindow::msaaColorImageView(int idx) const

指定されたマルチサンプリング・カラー画像ビューを返します。マルチサンプリングが使用されていない場合はVK_NULL_HANDLE を返します。

idx は [0, () - 1] の範囲でなければならない。swapChainImageCount

VkPhysicalDevice QVulkanWindow::physicalDevice() const

アクティブな物理デバイスを返します。

const VkPhysicalDeviceProperties *QVulkanWindow::physicalDeviceProperties() const

アクティブな物理デバイスのプロパティへのポインタを返します。

VkSampleCountFlagBits QVulkanWindow::sampleCountFlagBits() const

現在のサンプルカウントをVkSampleCountFlagBits の値として返します。

デフォルトのレンダーターゲットをターゲットにする場合は、VkPipelineMultisampleStateCreateInfo のrasterizationSamples フィールドをこの値に設定する必要があります。

setSampleCount() およびsupportedSampleCounts()も参照 。

void QVulkanWindow::setDeviceExtensions(const QByteArrayList &extensions)

有効にするデバイスextensions のリストを設定する。

サポートされていない拡張機能は無視される。

swapchain 拡張は常に自動的に追加されるので、このリストに含める必要はない。

[since 6.7] void QVulkanWindow::setEnabledFeaturesModifier(const QVulkanWindow::EnabledFeaturesModifier &modifier)

有効なデバイス機能変更関数modifier を設定します。

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

EnabledFeaturesModifierも参照して ください。

[since 6.7] void QVulkanWindow::setEnabledFeaturesModifier(QVulkanWindow::EnabledFeatures2Modifier modifier)

有効なデバイス機能を設定する 修正関数modifier 。

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

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

EnabledFeatures2Modifierも参照して ください。

void QVulkanWindow::setFlags(QVulkanWindow::Flags flags)

提供されたflags に基づいて動作を設定します。

flags()も参照 。

void QVulkanWindow::setPhysicalDeviceIndex(int idx)

インデックスidx を持つ物理デバイスの使用を要求する。このインデックスは、availablePhysicalDevices() から返されたリストに対応する。

デフォルトでは、最初の物理デバイスが使用される。

void QVulkanWindow::setPreferredColorFormats(const QList<VkFormat> &formats)

swapchainの優先formats 。

デフォルトでは、アプリケーション優先フォーマットは設定されません。この場合、サーフェスの優先書式が使用されるか、それがない場合はVK_FORMAT_B8G8R8A8_UNORM が使用される。

formats のリストは順番に並んでいる。最初のフォーマットがサポートされていない場合、2番目のフォーマットが考慮され、以下同様となる。リストのどの書式もサポートしていない場合、動作はデフォルトの場合と同じである。

初期化後に実際のフォーマットを照会するには、colorFormat （）を呼び出します。

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

void QVulkanWindow::setQueueCreateInfoModifier(const QVulkanWindow::QueueCreateInfoModifier &modifier)

キュー作成情報変更関数modifier を設定します。

QueueCreateInfoModifier も参照 。

void QVulkanWindow::setSampleCount(int sampleCount)

マルチサンプル・アンチエイリアシングを、与えられたsampleCount で要求する。有効な値は 1, 2, 4, 8, ... で、物理デバイスがサポートする最大値までです。

サンプルカウントが1より大きい場合、QVulkanWindow 、単にスワップチェーンの画像をターゲットにするのではなく、マルチサンプルカラーバッファを作成します。マルチサンプルバッファのレンダリングは、各フレームの終了時に非マルチサンプルバッファに分解されます。

サポートされているサンプル数のリストを調べるには、supportedSampleCounts （）を呼び出します。

レンダリングパイプラインを設定する場合は、sampleCountFlagBits() を呼び出して、アクティブなサンプルカウントをVkSampleCountFlagBits の値として取得します。

supportedSampleCounts() およびsampleCountFlagBits()も参照 。

QVulkanInfoVector<QVulkanExtension> QVulkanWindow::supportedDeviceExtensions()

setPhysicalDeviceIndex() で選択された物理デバイスから作成された論理デバイスでサポートされている拡張の リストを返す。

QList<int> QVulkanWindow::supportedSampleCounts()

setPhysicalDeviceIndex() によって選択された物理デバイスを使用するときにサポートされるサンプル数のセットを、ソートされたリストとして返します。

デフォルトでは、QVulkanWindow はサンプル数 1 を使用する。この関数が返すセットとは異なる値（2、4、8、...）を指定してsetSampleCount() を呼び出すことで、マルチサンプルのアンチエイリアシングを要求できる。

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

bool QVulkanWindow::supportsGrab() const

swapchainが転送元としての使用をサポートしている場合、trueを返す。つまり、grab （）が機能する。

VkImage QVulkanWindow::swapChainImage(int idx) const

指定されたスワップチェーンイメージを返す。

idx は [0, () - 1] の範囲でなければならない。swapChainImageCount

int QVulkanWindow::swapChainImageCount() const

スワップチェイン内の画像の数を返します。

QSize QVulkanWindow::swapChainImageSize() const

スワップチェーンの画像サイズを返します。

これは通常ウィンドウのサイズと一致するが、vkGetPhysicalDeviceSurfaceCapabilitiesKHR が固定サイズを報告している場合は異なることもある。

さらに、いくつかのプラットフォームで、Vulkan が報告するサーフェスサイズが、高 DPI スケーリングがアクティブな場合に異なることが確認されています。つまり、QWindow が報告するsize() とdevicePixelRatio() を乗算した値は、おそらく丸めの違いに起因して、ここから返される値と比較して、1 ピクセル小さいか大きいということです。レンダリングコードはこのことを認識し、関連するレンダリングロジックは、QWindow-報告されたサイズではなく、ここから返された値に基づいていなければなりません。どのピクセルサイズが理論的に正しいかにかかわらず、Vulkanレンダリングは、Vulkan APIが報告したサーフェスサイズにのみ依存しなければなりません。そうでなければ、例えばビューポートを設定するときに、アプリケーションが提供した値がVulkanの観点からアウトオブバウンズになる可能性があるため、検証エラーが発生する可能性があります。

VkImageView QVulkanWindow::swapChainImageView(int idx) const

指定されたスワップチェーンイメージビューを返します。

idx は [0, () - 1] の範囲でなければなりません。swapChainImageCount