この節では前節までで描画した(はず)の画像データを実際にファイルに書き出して見てみます。
見ることは出来ないが描画は行われたのだ…と信じることのできる人は見なくても構いませんが、「これ本当にちゃんと動いてるの？」という心はエンジニアにとって重要だということはお伝えしたいと思います。
画像ファイルを簡単に扱うために、stbと呼ばれる簡単に使えるヘッダライブラリを利用します。
まずはこちらからstb_image_write.hというヘッダファイルをダウンロードし、ソースファイルと同じ場所に配置してください。配置出来たら、メインのソースファイルで以下のようにインクルードとシンボル定義を書きます。
|
1 2 |
#define STB_IMAGE_WRITE_IMPLEMENTATION #include "stb_image_write.h" |
これで利用する準備は完了です。
stb_image_writeライブラリを使うと簡単に画像ファイルを書き出すことができます。今回はbmpファイルで書き出してみましょう。 stbi_write_bmp 関数を使って行えます。
|
1 |
stbi_write_bmp("img.bmp", screenWidth, screenHeight, 4, /* 画像データへのポインタ */) |
引数はそれぞれファイル名、幅、高さ、1画素当たりのバイト数、データです。第4引数が4のとき、それぞれの画素はRGBAをこの順でそれぞれ1バイト(符号なし8ビット)で表します。(ここはVulkanとは関係ない部分なので端折ります)
さて、画像のデータを取り出したいところですが、どこにあるのでしょう。3-2. メモリの確保で書いた内容を復習してください。データはメインメモリではなくGPUの中にあります。つまりこのままではアプリケーションからアクセスできません。そこでアプリケーション側のアドレス空間上にマップして、メインのプログラムから見れるようにする必要があります。そしてそれにはちょっとした段取りが必要です。
「GPU上のメモリには種類があり、適切に選択する必要がある」と書いたのを覚えていますでしょうか。実はGPU上のメモリには、GPUを扱うコンピュータ・アプリケーションの側(ホストと呼びます)からアクセスできるものとアクセスできないものがあります。そこで、メモリを確保するところで「目的のイメージにバインドできるメモリ」であるだけでなく「ホスト側から見えるメモリ」であるメモリを選択する必要があります。
具体的には以下のようにします。
|
1 2 3 4 5 6 7 8 9 10 11 |
bool suitableMemoryTypeFound = false; for (size_t i = 0; i < memProps.memoryTypeCount; i++) { if (imgMemReq.memoryTypeBits & (1 << i) && (memProps.memoryTypes[i].propertyFlags & vk::MemoryPropertyFlagBits::eHostVisible)) { imgMemAllocInfo.memoryTypeIndex = i; suitableMemoryTypeFound = true; break; } } |
i番目の種類のメモリタイプのプロパティを見て、HostVisible(ホスト側から見える)であることを確認しています。
これで準備が出来ました。GPUの描画処理が終わった後のところに処理を書いていきましょう。
マッピングは vk::device の mapMemory メソッドで行います。
|
1 |
void* imgData = device->mapMemory(imgMem.get(), 0, imgMemReq.size); |
第1引数はメモリオブジェクト、第2引数はデバイスメモリのマップしたい場所のオフセット、第3引数はマップするサイズです。第2引数と第3引数を使えば先頭から何バイト目の所から何バイト分の部分だけを扱う、ということもできますが、ここでは全部見たいのでこのようにしています。戻り値はマップされた場所のアドレスです。この imgData にアクセスすれば画像の生データにアクセスできます。
早速書き出してしまいましょう。
|
1 |
stbi_write_bmp("img.bmp", screenWidth, screenHeight, 4, imgData); |
マップしたメモリはきちんと後始末します。
|
1 |
device->unmapMemory(imgMem.get()); |
さて、無事img.bmpというファイル名で画像は書き出されましたでしょうか。筆者の環境ではこのようになりました。
やりました！無事赤い三角形が描画出来ています！なんかちょっと背景が紫ですが。
描画した以外の部分は何も触っていないので、そこがどのようになるかは未定義です。ちょっと気持ち悪いですね。そこで、レンダーパスの設定で描画処理が始まる前に一度アタッチメント全体を特定の色でクリアすることができます。具体的には以下のようにします。
|
1 2 3 4 5 6 7 8 9 |
vk::AttachmentDescription attachments[1]; attachments[0].format = vk::Format::eR8G8B8A8Unorm; attachments[0].samples = vk::SampleCountFlagBits::e1; attachments[0].loadOp = vk::AttachmentLoadOp::eClear; attachments[0].storeOp = vk::AttachmentStoreOp::eStore; attachments[0].stencilLoadOp = vk::AttachmentLoadOp::eDontCare; attachments[0].stencilStoreOp = vk::AttachmentStoreOp::eDontCare; attachments[0].initialLayout = vk::ImageLayout::eUndefined; attachments[0].finalLayout = vk::ImageLayout::eGeneral; |
アタッチメントの設定で loadOp に eClear を指定します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
vk::ClearValue clearVal[1]; clearVal[0].color.float32[0] = 0.0f; clearVal[0].color.float32[1] = 0.0f; clearVal[0].color.float32[2] = 0.0f; clearVal[0].color.float32[3] = 1.0f; vk::RenderPassBeginInfo renderpassBeginInfo; renderpassBeginInfo.renderPass = renderpass.get(); renderpassBeginInfo.framebuffer = frameBuf.get(); renderpassBeginInfo.renderArea = vk::Rect2D({ 0,0 }, { screenWidth, screenHeight }); renderpassBeginInfo.clearValueCount = 1; renderpassBeginInfo.pClearValues = clearVal; cmdBufs[0]->beginRenderPass(renderpassBeginInfo, vk::SubpassContents::eInline); |
どのような色でクリアするかの設定をレンダーパス開始コマンドの際に行います。ここでは(0.0, 0.0, 0.0, 1.0)、RGBが0でアルファだけ1ということは真っ黒でクリアすることになります。実行してみましょう。
黒と赤になりました。
この節では、前節までで三角形の描画がきちんと出来ていたことをファイルに書き出して確認しました。
次章ではウィンドウへの表示をやります。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
// 環境に合わせて #define VK_USE_PLATFORM_WIN32_KHR #define VULKAN_HPP_TYPESAFE_CONVERSION #define STB_IMAGE_WRITE_IMPLEMENTATION #include "stb_image_write.h" #include <vulkan/vulkan.hpp> #include <fstream> #include <filesystem> #include <iostream> #include <vector> const uint32_t screenWidth = 640; const uint32_t screenHeight = 480; int main() { vk::InstanceCreateInfo createInfo; vk::UniqueInstance instance; instance = vk::createInstanceUnique(createInfo); std::vector<vk::PhysicalDevice> physicalDevices = instance->enumeratePhysicalDevices(); vk::PhysicalDevice physicalDevice; bool existsSuitablePhysicalDevice = false; uint32_t graphicsQueueFamilyIndex; for (size_t i = 0; i < physicalDevices.size(); i++) { std::vector<vk::QueueFamilyProperties> queueProps = physicalDevices[i].getQueueFamilyProperties(); bool existsGraphicsQueue = false; for (size_t j = 0; j < queueProps.size(); i++) { if (queueProps[j].queueFlags & vk::QueueFlagBits::eGraphics) { existsGraphicsQueue = true; graphicsQueueFamilyIndex = j; break; } } if (existsGraphicsQueue) { physicalDevice = physicalDevices[i]; existsSuitablePhysicalDevice = true; break; } } if (!existsSuitablePhysicalDevice) { std::cerr << "使用可能な物理デバイスがありません。" << std::endl; return -1; } vk::DeviceCreateInfo devCreateInfo; vk::DeviceQueueCreateInfo queueCreateInfo[1]; queueCreateInfo[0].queueFamilyIndex = graphicsQueueFamilyIndex; queueCreateInfo[0].queueCount = 1; float queuePriorities[1] = { 1.0 }; queueCreateInfo[0].pQueuePriorities = queuePriorities; devCreateInfo.pQueueCreateInfos = queueCreateInfo; devCreateInfo.queueCreateInfoCount = 1; vk::UniqueDevice device = physicalDevice.createDeviceUnique(devCreateInfo); vk::Queue graphicsQueue = device->getQueue(graphicsQueueFamilyIndex, 0); vk::CommandPoolCreateInfo cmdPoolCreateInfo; cmdPoolCreateInfo.queueFamilyIndex = graphicsQueueFamilyIndex; vk::UniqueCommandPool cmdPool = device->createCommandPoolUnique(cmdPoolCreateInfo); vk::CommandBufferAllocateInfo cmdBufAllocInfo; cmdBufAllocInfo.commandPool = cmdPool.get(); cmdBufAllocInfo.commandBufferCount = 1; cmdBufAllocInfo.level = vk::CommandBufferLevel::ePrimary; std::vector<vk::UniqueCommandBuffer> cmdBufs = device->allocateCommandBuffersUnique(cmdBufAllocInfo); vk::ImageCreateInfo imgCreateInfo; imgCreateInfo.imageType = vk::ImageType::e2D; imgCreateInfo.extent = vk::Extent3D(screenWidth, screenHeight, 1); imgCreateInfo.mipLevels = 1; imgCreateInfo.arrayLayers = 1; imgCreateInfo.format = vk::Format::eR8G8B8A8Unorm; imgCreateInfo.tiling = vk::ImageTiling::eLinear; imgCreateInfo.initialLayout = vk::ImageLayout::eUndefined; imgCreateInfo.usage = vk::ImageUsageFlagBits::eColorAttachment; imgCreateInfo.sharingMode = vk::SharingMode::eExclusive; imgCreateInfo.samples = vk::SampleCountFlagBits::e1; vk::UniqueImage image = device->createImageUnique(imgCreateInfo); vk::PhysicalDeviceMemoryProperties memProps = physicalDevice.getMemoryProperties(); vk::MemoryRequirements imgMemReq = device->getImageMemoryRequirements(image.get()); vk::MemoryAllocateInfo imgMemAllocInfo; imgMemAllocInfo.allocationSize = imgMemReq.size; bool suitableMemoryTypeFound = false; for (size_t i = 0; i < memProps.memoryTypeCount; i++) { if (imgMemReq.memoryTypeBits & (1 << i) && (memProps.memoryTypes[i].propertyFlags & vk::MemoryPropertyFlagBits::eHostVisible)) { imgMemAllocInfo.memoryTypeIndex = i; suitableMemoryTypeFound = true; break; } } if (!suitableMemoryTypeFound) { std::cerr << "使用可能なメモリタイプがありません。" << std::endl; return -1; } vk::UniqueDeviceMemory imgMem = device->allocateMemoryUnique(imgMemAllocInfo); device->bindImageMemory(image.get(), imgMem.get(), 0); vk::AttachmentDescription attachments[1]; attachments[0].format = vk::Format::eR8G8B8A8Unorm; attachments[0].samples = vk::SampleCountFlagBits::e1; attachments[0].loadOp = vk::AttachmentLoadOp::eClear; attachments[0].storeOp = vk::AttachmentStoreOp::eStore; attachments[0].stencilLoadOp = vk::AttachmentLoadOp::eDontCare; attachments[0].stencilStoreOp = vk::AttachmentStoreOp::eDontCare; attachments[0].initialLayout = vk::ImageLayout::eUndefined; attachments[0].finalLayout = vk::ImageLayout::eGeneral; vk::AttachmentReference subpass0_attachmentRefs[1]; subpass0_attachmentRefs[0].attachment = 0; subpass0_attachmentRefs[0].layout = vk::ImageLayout::eColorAttachmentOptimal; vk::SubpassDescription subpasses[1]; subpasses[0].pipelineBindPoint = vk::PipelineBindPoint::eGraphics; subpasses[0].colorAttachmentCount = 1; subpasses[0].pColorAttachments = subpass0_attachmentRefs; vk::RenderPassCreateInfo renderpassCreateInfo; renderpassCreateInfo.attachmentCount = 1; renderpassCreateInfo.pAttachments = attachments; renderpassCreateInfo.subpassCount = 1; renderpassCreateInfo.pSubpasses = subpasses; renderpassCreateInfo.dependencyCount = 0; renderpassCreateInfo.pDependencies = nullptr; vk::UniqueRenderPass renderpass = device->createRenderPassUnique(renderpassCreateInfo); vk::Viewport viewports[1]; viewports[0].x = 0.0; viewports[0].y = 0.0; viewports[0].minDepth = 0.0; viewports[0].maxDepth = 1.0; viewports[0].width = screenWidth; viewports[0].height = screenHeight; vk::Rect2D scissors[1]; scissors[0].offset = { 0, 0 }; scissors[0].extent = { screenWidth, screenHeight }; vk::PipelineViewportStateCreateInfo viewportState; viewportState.viewportCount = 1; viewportState.pViewports = viewports; viewportState.scissorCount = 1; viewportState.pScissors = scissors; vk::PipelineVertexInputStateCreateInfo vertexInputInfo; vertexInputInfo.vertexAttributeDescriptionCount = 0; vertexInputInfo.pVertexAttributeDescriptions = nullptr; vertexInputInfo.vertexBindingDescriptionCount = 0; vertexInputInfo.pVertexBindingDescriptions = nullptr; vk::PipelineInputAssemblyStateCreateInfo inputAssembly; inputAssembly.topology = vk::PrimitiveTopology::eTriangleList; inputAssembly.primitiveRestartEnable = false; vk::PipelineRasterizationStateCreateInfo rasterizer; rasterizer.depthClampEnable = false; rasterizer.rasterizerDiscardEnable = false; rasterizer.polygonMode = vk::PolygonMode::eFill; rasterizer.lineWidth = 1.0f; rasterizer.cullMode = vk::CullModeFlagBits::eBack; rasterizer.frontFace = vk::FrontFace::eClockwise; rasterizer.depthBiasEnable = false; vk::PipelineMultisampleStateCreateInfo multisample; multisample.sampleShadingEnable = false; multisample.rasterizationSamples = vk::SampleCountFlagBits::e1; vk::PipelineColorBlendAttachmentState blendattachment[1]; blendattachment[0].colorWriteMask = vk::ColorComponentFlagBits::eA | vk::ColorComponentFlagBits::eR | vk::ColorComponentFlagBits::eG | vk::ColorComponentFlagBits::eB; blendattachment[0].blendEnable = false; vk::PipelineColorBlendStateCreateInfo blend; blend.logicOpEnable = false; blend.attachmentCount = 1; blend.pAttachments = blendattachment; vk::PipelineLayoutCreateInfo layoutCreateInfo; layoutCreateInfo.setLayoutCount = 0; layoutCreateInfo.pSetLayouts = nullptr; vk::UniquePipelineLayout pipelineLayout = device->createPipelineLayoutUnique(layoutCreateInfo); size_t vertSpvFileSz = std::filesystem::file_size("vert.spv"); std::ifstream vertSpvFile("vert.spv", std::ios_base::binary); std::vector<char> vertSpvFileData(vertSpvFileSz); vertSpvFile.read(vertSpvFileData.data(), vertSpvFileSz); vk::ShaderModuleCreateInfo vertShaderCreateInfo; vertShaderCreateInfo.codeSize = vertSpvFileSz; vertShaderCreateInfo.pCode = reinterpret_cast<const uint32_t*>(vertSpvFileData.data()); vk::UniqueShaderModule vertShader = device->createShaderModuleUnique(vertShaderCreateInfo); size_t fragSpvFileSz = std::filesystem::file_size("frag.spv"); std::ifstream fragSpvFile("frag.spv", std::ios_base::binary); std::vector<char> fragSpvFileData(fragSpvFileSz); fragSpvFile.read(fragSpvFileData.data(), fragSpvFileSz); vk::ShaderModuleCreateInfo fragShaderCreateInfo; fragShaderCreateInfo.codeSize = fragSpvFileSz; fragShaderCreateInfo.pCode = reinterpret_cast<const uint32_t*>(fragSpvFileData.data()); vk::UniqueShaderModule fragShader = device->createShaderModuleUnique(fragShaderCreateInfo); vk::PipelineShaderStageCreateInfo shaderStage[2]; shaderStage[0].stage = vk::ShaderStageFlagBits::eVertex; shaderStage[0].module = vertShader.get(); shaderStage[0].pName = "main"; shaderStage[1].stage = vk::ShaderStageFlagBits::eFragment; shaderStage[1].module = fragShader.get(); shaderStage[1].pName = "main"; vk::GraphicsPipelineCreateInfo pipelineCreateInfo; pipelineCreateInfo.pViewportState = &viewportState; pipelineCreateInfo.pVertexInputState = &vertexInputInfo; pipelineCreateInfo.pInputAssemblyState = &inputAssembly; pipelineCreateInfo.pRasterizationState = &rasterizer; pipelineCreateInfo.pMultisampleState = &multisample; pipelineCreateInfo.pColorBlendState = &blend; pipelineCreateInfo.layout = pipelineLayout.get(); pipelineCreateInfo.renderPass = renderpass.get(); pipelineCreateInfo.subpass = 0; pipelineCreateInfo.stageCount = 2; pipelineCreateInfo.pStages = shaderStage; vk::UniquePipeline pipeline = device->createGraphicsPipelineUnique(nullptr, pipelineCreateInfo); vk::ImageViewCreateInfo imgViewCreateInfo; imgViewCreateInfo.image = image.get(); imgViewCreateInfo.viewType = vk::ImageViewType::e2D; imgViewCreateInfo.format = vk::Format::eR8G8B8A8Unorm; imgViewCreateInfo.components.r = vk::ComponentSwizzle::eIdentity; imgViewCreateInfo.components.g = vk::ComponentSwizzle::eIdentity; imgViewCreateInfo.components.b = vk::ComponentSwizzle::eIdentity; imgViewCreateInfo.components.a = vk::ComponentSwizzle::eIdentity; imgViewCreateInfo.subresourceRange.aspectMask = vk::ImageAspectFlagBits::eColor; imgViewCreateInfo.subresourceRange.baseMipLevel = 0; imgViewCreateInfo.subresourceRange.levelCount = 1; imgViewCreateInfo.subresourceRange.baseArrayLayer = 0; imgViewCreateInfo.subresourceRange.layerCount = 1; vk::UniqueImageView imgView = device->createImageViewUnique(imgViewCreateInfo); vk::ImageView frameBufAttachments[1]; frameBufAttachments[0] = imgView.get(); vk::FramebufferCreateInfo frameBufCreateInfo; frameBufCreateInfo.width = screenWidth; frameBufCreateInfo.height = screenHeight; frameBufCreateInfo.layers = 1; frameBufCreateInfo.renderPass = renderpass.get(); frameBufCreateInfo.attachmentCount = 1; frameBufCreateInfo.pAttachments = frameBufAttachments; vk::UniqueFramebuffer frameBuf = device->createFramebufferUnique(frameBufCreateInfo); vk::CommandBufferBeginInfo cmdBeginInfo; cmdBufs[0]->begin(cmdBeginInfo); vk::ClearValue clearVal[1]; clearVal[0].color.float32[0] = 0.0f; clearVal[0].color.float32[1] = 0.0f; clearVal[0].color.float32[2] = 0.0f; clearVal[0].color.float32[3] = 1.0f; vk::RenderPassBeginInfo renderpassBeginInfo; renderpassBeginInfo.renderPass = renderpass.get(); renderpassBeginInfo.framebuffer = frameBuf.get(); renderpassBeginInfo.renderArea = vk::Rect2D({ 0,0 }, { screenWidth, screenHeight }); renderpassBeginInfo.clearValueCount = 1; renderpassBeginInfo.pClearValues = clearVal; cmdBufs[0]->beginRenderPass(renderpassBeginInfo, vk::SubpassContents::eInline); cmdBufs[0]->bindPipeline(vk::PipelineBindPoint::eGraphics, pipeline.get()); cmdBufs[0]->draw(3, 1, 0, 0); cmdBufs[0]->endRenderPass(); cmdBufs[0]->end(); vk::CommandBuffer submitCmdBuf[1] = { cmdBufs[0].get() }; vk::SubmitInfo submitInfo; submitInfo.commandBufferCount = 1; submitInfo.pCommandBuffers = submitCmdBuf; graphicsQueue.submit({ submitInfo }, nullptr); graphicsQueue.waitIdle(); void* imgData = device->mapMemory(imgMem.get(), 0, imgMemReq.size); stbi_write_bmp("img.bmp", screenWidth, screenHeight, 4, imgData); device->unmapMemory(imgMem.get()); return 0; } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
#version 450 #extension GL_ARB_separate_shader_objects : enable void main() { if(gl_VertexIndex == 0) { gl_Position = vec4(0.0, -0.5, 0.0, 1.0); } else if(gl_VertexIndex == 1) { gl_Position = vec4(0.5, 0.5, 0.0, 1.0); } else if(gl_VertexIndex == 2) { gl_Position = vec4(-0.5, 0.5, 0.0, 1.0); } } |
|
1 2 3 4 5 6 7 8 |
#version 450 #extension GL_ARB_separate_shader_objects : enable layout(location = 0) out vec4 outColor; void main() { outColor = vec4(1.0, 0.0, 0.0, 1.0); } |