Vulkan APIレンダリングをQt GUIで簡単にする：QVulkanWindow::defaultRenderPass()の使い方

QVulkanWindow::defaultRenderPass() は、Qt GUI 6.7.2以降で Vulkan API を使用してレンダリングを行う際に利用できる関数です。この関数は、デフォルトのレンダーパスオブジェクトを返します。レンダーパスは、レンダリングパイプラインを定義し、フレームバッファ、カラーアタッチメント、深さバッファなどのレンダリングターゲットを構成します。

デフォルトレンダーパスの利点

デフォルトレンダーパスを使用する利点は以下の通りです。

パフォーマンス
デフォルトレンダーパスは、最適化されたコードで実装されているため、パフォーマンスが向上します。
汎用性
多くの場合、デフォルトレンダーパスは一般的なレンダリングタスクに十分な機能を提供します。
簡素性
複雑なレンダーパスの設定を必要とせず、基本的なレンダリングを行うことができます。

デフォルトレンダーパスの使用方法

デフォルトレンダーパスを使用するには、以下の手順を実行する必要があります。

QVulkanWindow オブジェクトを作成します。
defaultRenderPass() 関数を呼び出して、デフォルトレンダーパスオブジェクトを取得します。
レンダリングコマンドを実行する前に、レンダーパスオブジェクトを vkCmdBeginRenderPass() 関数に渡します。
レンダリングコマンドを実行した後は、vkCmdEndRenderPass() 関数を使用してレンダーパスを終了します。

例

// QVulkanWindow オブジェクトを作成します。
QVulkanWindow window;

// デフォルトレンダーパスオブジェクトを取得します。
VkRenderPass renderPass = window.defaultRenderPass();

// レンダリングコマンドを実行する前に、レンダーパスオブジェクトを vkCmdBeginRenderPass() 関数に渡します。
vkCmdBeginRenderPass(commandBuffer, &renderPassInfo, VK_SUBPASS_LOAD_STORE);

// レンダリングコマンドを実行します。

// レンダリングコマンドを実行した後は、vkCmdEndRenderPass() 関数を使用してレンダーパスを終了します。
vkCmdEndRenderPass(commandBuffer);

デフォルトレンダーパスは、Vulkan API のバージョンによって異なる場合があります。使用している Vulkan API バージョンに対応していることを確認してください。
デフォルトレンダーパスは、すべてのレンダリングタスクに適しているわけではありません。より複雑なレンダリングを行う場合は、独自のレンダーパスを作成する必要があります。

#include <QVulkanWindow>
#include <QtQuick/QSGSimpleRenderNode>

class TriangleRenderer : public QSGSimpleRenderNode
{
public:
    TriangleRenderer();

protected:
    void prepare(QSGContext *context) override;
    void render(QSGContext *context) override;

private:
    VkRenderPass renderPass;
    VkPipelineLayout pipelineLayout;
    VkPipeline graphicsPipeline;
    VkCommandBuffer commandBuffer;
};

TriangleRenderer::TriangleRenderer()
{
    // Vulkan デバイスとキューを取得します。
    QVulkanWindow *window = static_cast<QVulkanWindow *>(scene()->parent());
    VkDevice device = window->vulkanDevice();
    VkQueue queue = window->vulkanQueue();

    // デフォルトレンダーパスを取得します。
    renderPass = window.defaultRenderPass();

    // シェーダーモジュールを作成します。
    VkShaderModule vertShaderModule = createShaderModule(device, "shaders/triangle.vert.spv");
    VkShaderModule fragShaderModule = createShaderModule(device, "shaders/triangle.frag.spv");

    // パイプラインレイアウトを作成します。
    VkPipelineLayoutCreateInfo pipelineLayoutCreateInfo = {};
    pipelineLayoutCreateInfo.sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO;
    pipelineLayoutCreateInfo.setLayoutCount(0);
    pipelineLayoutCreateInfo.pSetLayouts = nullptr;
    pipelineLayoutCreateInfo.pushConstantRangeCount = 0;
    pipelineLayoutCreateInfo.pPushConstantRanges = nullptr;

    if (vkCreatePipelineLayout(device, &pipelineLayoutCreateInfo, nullptr, &pipelineLayout) != VK_SUCCESS) {
        throw std::runtime_error("Failed to create pipeline layout");
    }

    // グラフィックスパイプラインを作成します。
    VkGraphicsPipelineCreateInfo pipelineCreateInfo = {};
    pipelineCreateInfo.sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO;
    pipelineCreateInfo.stageCount = 2;
    pipelineCreateInfo.pStages = stages;
    pipelineCreateInfo.layout = pipelineLayout;
    pipelineCreateInfo.renderPass = renderPass;

    // 頂点フォーマットを設定します。
    VkVertexInputBindingDescription vertexInputBinding = {};
    vertexInputBinding.binding = 0;
    vertexInputBinding.stride = sizeof(Vertex);
    vertexInputBinding.inputRate = VK_VERTEX_INPUT_RATE_VERTEX;

    VkVertexInputAttributeDescription vertexInputAttribute = {};
    vertexInputAttribute.location = 0;
    vertexInputAttribute.binding = 0;
    vertexInputAttribute.format = VK_FORMAT_R32G32B32_SFLOAT;
    vertexInputAttribute.offset = 0;

    VkPipelineVertexInputStateCreateInfo vertexInputStateCreateInfo = {};
    vertexInputStateCreateInfo.sType = VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO;
    vertexInputStateCreateInfo.vertexBindingDescriptionCount = 1;
    vertexInputStateCreateInfo.pVertexBindingDescriptions = &vertexInputBinding;
    vertexInputStateCreateInfo.vertexAttributeDescriptionCount = 1;
    vertexInputStateCreateInfo.pVertexAttributeDescriptions = &vertexInputAttribute;

    // ビューポートを設定します。
    VkViewport viewport = {};
    viewport.width = width();
    viewport.height = height();
    viewport.x = 0.0f;
    viewport.y = 0.0f;
    viewport.minDepth = 0.0f;
    viewport.maxDepth = 1.0f;

    VkScissorRect2D scissor = {};
    scissor.x = 0;
    scissor.y = 0;
    scissor.width = width();
    scissor.height = height();

    VkPipelineViewportStateCreateInfo viewportStateCreateInfo = {};
    viewportStateCreateInfo.sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO;
    viewportStateCreateInfo.viewportCount = 1;
    viewportStateCreateInfo.pViewports = &viewport;
    viewportStateCreateInfo.scissorCount = 1;
    viewportStateCreateInfo.pScissors = &scissor;

    // カラーアタッチメントを設定します。
    VkColorAttachmentDescription color

代替方法

QVulkanWindow::defaultRenderPass() の代替方法として、以下の方法が考えられます。

ライブラリを使用する
vk-helper や vk-pp などのライブラリを使用すると、レンダーパスの作成を簡略化できます。これらのライブラリは、一般的なレンダーパスのテンプレートを提供し、コードの量を減らすことができます。
VkRenderPassCreateInfo を使用してデフォルトレンダーパスをカスタマイズする
デフォルトレンダーパスをベースにして、必要に応じて変更を加えることができます。これは、デフォルトレンダーパスの機能の大部分を使用したいが、特定の要件を満たすためにいくつかの変更が必要な場合に役立ちます。
VkRenderPassCreateInfo を使用して独自のレンダーパスを作成する
これが最も汎用性が高く、柔軟性の高い方法です。この方法を使用すると、レンダリングターゲット、サブパス、レンダーパス依存関係などのすべての側面を完全に制御できます。

それぞれの方法の詳細

VkRenderPassCreateInfo を使用して独自のレンダーパスを作成する

この方法は、最も詳細な制御を提供しますが、最も複雑でもあります。VkRenderPassCreateInfo 構造体には、レンダーパスのすべての側面を定義するための多くのフィールドがあります。

VkRenderPassCreateInfo を使用してデフォルトレンダーパスをカスタマイズする

この方法は、独自のレンダーパスを作成するよりも簡単ですが、デフォルトレンダーパスの機能に制限されます。デフォルトレンダーパスをカスタマイズするには、VkRenderPassCreateInfo 構造体のフィールドをいくつか変更する必要があります。

ライブラリを使用する

ライブラリを使用すると、レンダーパスの作成を簡略化できます。ライブラリは、一般的なレンダーパスのテンプレートを提供し、コードの量を減らすことができます。

どの方法を選択するべきか

どの方法を選択するかは、要件によって異なります。複雑なレンダリングを行う場合は、独自のレンダーパスを作成する必要があります。デフォルトレンダーパスの機能の大部分を使用したいが、特定の要件を満たすためにいくつかの変更が必要な場合は、デフォルトレンダーパスをカスタマイズする必要があります。コードを簡略化したい場合は、ライブラリを使用することを検討してください。