source/backends/vulkan/pipelinestate_backend.cpp

   1 #include <msp/core/hash.h>
   2 #include "batch.h"
   3 #include "blend.h"
   4 #include "buffer.h"
   5 #include "depthtest.h"
   6 #include "device.h"
   7 #include "framebuffer.h"
   8 #include "pipelinestate.h"
   9 #include "pipelinestate_backend.h"
  10 #include "program.h"
  11 #include "rect.h"
  12 #include "sampler.h"
  13 #include "stenciltest.h"
  14 #include "structurebuilder.h"
  15 #include "texture.h"
  16 #include "uniformblock.h"
  17 #include "vertexsetup.h"
  18 #include "vulkan.h"
  19
  20 using namespace std;
  21
  22 namespace Msp {
  23 namespace GL {
  24
  25 VulkanPipelineState::VulkanPipelineState():
  26         device(Device::get_current())
  27 { }
  28
  29 VulkanPipelineState::VulkanPipelineState(VulkanPipelineState &&other):
  30         device(other.device),
  31         handle(other.handle)
  32 { }
  33
  34 void VulkanPipelineState::update() const
  35 {
  36         const PipelineState &self = *static_cast<const PipelineState *>(this);
  37
  38         if(self.changes&PipelineState::VERTEX_SETUP)
  39                 self.vertex_setup->refresh();
  40
  41         constexpr unsigned pipeline_mask = PipelineState::SHPROG|PipelineState::VERTEX_SETUP|PipelineState::FACE_CULL|
  42                 PipelineState::DEPTH_TEST|PipelineState::STENCIL_TEST|PipelineState::BLEND|PipelineState::PRIMITIVE_TYPE;
  43         if(self.changes&pipeline_mask)
  44                 handle = device.get_pipeline_cache().get_pipeline(self);
  45
  46         if(self.changes&(PipelineState::SHPROG|PipelineState::UNIFORMS|PipelineState::TEXTURES))
  47         {
  48                 unsigned changed_sets = (self.changes&PipelineState::SHPROG ? ~0U : 0U);
  49                 for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
  50                         if(u.changed || changed_sets==~0U)
  51                         {
  52                                 u.used = self.shprog->uses_uniform_block_binding(u.binding);
  53                                 if(u.binding>=0)
  54                                         changed_sets |= 1<<(u.binding>>20);
  55                                 u.changed = false;
  56                         }
  57                 for(const PipelineState::BoundTexture &t: self.textures)
  58                         if(t.changed || changed_sets==~0U)
  59                         {
  60                                 t.used = self.shprog->uses_texture_binding(t.binding);
  61                                 changed_sets |= 1<<(t.binding>>20);
  62                                 if(t.sampler)
  63                                         t.sampler->refresh();
  64                                 t.changed = false;
  65                         }
  66
  67                 descriptor_set_handles.resize(self.shprog->get_n_descriptor_sets());
  68                 for(unsigned i=0; i<descriptor_set_handles.size(); ++i)
  69                         if(changed_sets&(1<<i))
  70                                 descriptor_set_handles[i] = device.get_pipeline_cache().get_descriptor_set(self, i);
  71         }
  72
  73         self.changes = 0;
  74 }
  75
  76 uint64_t VulkanPipelineState::compute_hash() const
  77 {
  78         const PipelineState &self = *static_cast<const PipelineState *>(this);
  79         const FrameFormat &format = self.framebuffer->get_format();
  80
  81         uint64_t result = hash<64>(self.shprog);
  82         result = hash_update<64>(result, self.vertex_setup->compute_hash());
  83         result = hash_round<64>(result, self.primitive_type);
  84
  85         if(self.front_face!=NON_MANIFOLD && self.face_cull!=NO_CULL)
  86         {
  87                 result = hash_round<64>(result, self.front_face);
  88                 result = hash_round<64>(result, self.face_cull);
  89         }
  90
  91         result = hash_round<64>(result, format.get_samples());
  92
  93         if(const DepthTest *depth_test = self.depth_test)
  94                 if(depth_test->enabled)
  95                 {
  96                         result = hash_round<64>(result, depth_test->compare);
  97                         result = hash_update<64>(result, depth_test->write);
  98                 }
  99
 100         if(const StencilTest *stencil_test = self.stencil_test)
 101                 if(stencil_test->enabled)
 102                 {
 103                         result = hash_round<64>(result, stencil_test->compare);
 104                         result = hash_round<64>(result, stencil_test->stencil_fail_op);
 105                         result = hash_round<64>(result, stencil_test->depth_fail_op);
 106                         result = hash_round<64>(result, stencil_test->depth_pass_op);
 107                         result = hash_update<64>(result, stencil_test->reference);
 108                 }
 109
 110         if(const Blend *blend = self.blend)
 111                 if(blend->enabled)
 112                 {
 113                         result = hash_round<64>(result, blend->equation);
 114                         result = hash_round<64>(result, blend->src_factor);
 115                         result = hash_round<64>(result, blend->dst_factor);
 116                         result = hash_round<64>(result, blend->write_mask);
 117                 }
 118
 119         for(FrameAttachment a: format)
 120                 result = hash_update<64>(result, a);
 121
 122         return result;
 123 }
 124
 125 void VulkanPipelineState::fill_creation_info(vector<char> &buffer) const
 126 {
 127         const PipelineState &self = *static_cast<const PipelineState *>(this);
 128
 129         const FrameFormat &format = self.framebuffer->get_format();
 130         VkRenderPass render_pass = device.get_pipeline_cache().get_render_pass(format, false, false, false);
 131
 132         unsigned n_color_attachments = 0;
 133         for(FrameAttachment a: format)
 134         {
 135                 unsigned attach_pt = get_attach_point(a);
 136                 if(attach_pt!=get_attach_point(DEPTH_ATTACHMENT) && attach_pt!=get_attach_point(STENCIL_ATTACHMENT))
 137                         ++n_color_attachments;
 138         }
 139
 140         StructureBuilder sb(buffer, 10);
 141         VkGraphicsPipelineCreateInfo *&pipeline_info = sb.add<VkGraphicsPipelineCreateInfo>();
 142         VkPipelineInputAssemblyStateCreateInfo *&input_assembly_info = sb.add<VkPipelineInputAssemblyStateCreateInfo>();
 143         VkPipelineViewportStateCreateInfo *&viewport_info = sb.add<VkPipelineViewportStateCreateInfo>();
 144         VkPipelineRasterizationStateCreateInfo *&raster_info = sb.add<VkPipelineRasterizationStateCreateInfo>();
 145         VkPipelineMultisampleStateCreateInfo *&multisample_info = sb.add<VkPipelineMultisampleStateCreateInfo>();
 146         VkPipelineDepthStencilStateCreateInfo *&depth_stencil_info = sb.add<VkPipelineDepthStencilStateCreateInfo>();
 147         VkPipelineColorBlendStateCreateInfo *&blend_info = sb.add<VkPipelineColorBlendStateCreateInfo>();
 148         VkPipelineColorBlendAttachmentState *&blend_attachments = sb.add<VkPipelineColorBlendAttachmentState>(n_color_attachments);
 149         VkPipelineDynamicStateCreateInfo *&dynamic_info = sb.add<VkPipelineDynamicStateCreateInfo>();
 150         VkDynamicState *&dynamic_states = sb.add<VkDynamicState>(2);
 151
 152         input_assembly_info->sType = VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO;
 153         input_assembly_info->topology = static_cast<VkPrimitiveTopology>(get_vulkan_primitive_type(self.primitive_type));
 154         input_assembly_info->primitiveRestartEnable = true;
 155
 156         viewport_info->sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO;
 157         viewport_info->viewportCount = 1;
 158         viewport_info->pViewports = 0;
 159         viewport_info->scissorCount = 1;
 160         viewport_info->pScissors = 0;
 161
 162         raster_info->sType = VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO;
 163         raster_info->depthClampEnable = VK_FALSE;
 164         raster_info->rasterizerDiscardEnable = VK_FALSE;
 165         raster_info->polygonMode = VK_POLYGON_MODE_FILL;
 166         if(self.face_cull==NO_CULL || self.front_face==NON_MANIFOLD)
 167         {
 168                 raster_info->cullMode = VK_CULL_MODE_NONE;
 169                 raster_info->frontFace = VK_FRONT_FACE_COUNTER_CLOCKWISE;
 170         }
 171         else
 172         {
 173                 raster_info->cullMode = (self.face_cull==CULL_FRONT ? VK_CULL_MODE_FRONT_BIT : VK_CULL_MODE_BACK_BIT);
 174                 raster_info->frontFace = (self.front_face==CLOCKWISE ? VK_FRONT_FACE_CLOCKWISE : VK_FRONT_FACE_COUNTER_CLOCKWISE);
 175         }
 176         raster_info->depthBiasEnable = VK_FALSE;
 177         raster_info->depthBiasConstantFactor = 0.0f;
 178         raster_info->depthBiasClamp = 0.0f;
 179         raster_info->depthBiasSlopeFactor = 0.0f;
 180         raster_info->lineWidth = 1.0f;
 181
 182         multisample_info->sType = VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO;
 183         multisample_info->rasterizationSamples = static_cast<VkSampleCountFlagBits>(get_vulkan_samples(format.get_samples()));
 184         multisample_info->sampleShadingEnable = VK_FALSE;
 185         multisample_info->minSampleShading = 1.0f;
 186         multisample_info->pSampleMask = 0;
 187         multisample_info->alphaToCoverageEnable = VK_FALSE;
 188         multisample_info->alphaToOneEnable = VK_FALSE;
 189
 190         depth_stencil_info->sType = VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO;
 191         if(const DepthTest *depth_test = self.depth_test)
 192         {
 193                 depth_stencil_info->depthTestEnable = depth_test->enabled;
 194                 depth_stencil_info->depthWriteEnable = depth_test->write;
 195                 depth_stencil_info->depthCompareOp = static_cast<VkCompareOp>(get_vulkan_predicate(depth_test->compare));
 196                 depth_stencil_info->depthBoundsTestEnable = VK_FALSE;
 197         }
 198         if(const StencilTest *stencil_test = self.stencil_test)
 199         {
 200                 depth_stencil_info->stencilTestEnable = stencil_test->enabled;
 201                 depth_stencil_info->front.failOp = static_cast<VkStencilOp>(get_vulkan_stencil_op(stencil_test->stencil_fail_op));
 202                 depth_stencil_info->front.passOp = static_cast<VkStencilOp>(get_vulkan_stencil_op(stencil_test->depth_pass_op));
 203                 depth_stencil_info->front.depthFailOp = static_cast<VkStencilOp>(get_vulkan_stencil_op(stencil_test->depth_fail_op));
 204                 depth_stencil_info->front.compareOp = static_cast<VkCompareOp>(get_vulkan_predicate(stencil_test->compare));
 205                 depth_stencil_info->front.compareMask = 0xFFFFFFFFU;
 206                 depth_stencil_info->front.writeMask = 0xFFFFFFFFU;
 207                 depth_stencil_info->front.reference = stencil_test->reference;
 208                 depth_stencil_info->back = depth_stencil_info->front;
 209         }
 210
 211         if(const Blend *blend = self.blend)
 212         {
 213                 for(unsigned i=0; i<n_color_attachments; ++i)
 214                 {
 215                         blend_attachments[i].blendEnable = blend->enabled;
 216                         blend_attachments[i].srcColorBlendFactor = static_cast<VkBlendFactor>(get_vulkan_blend_factor(blend->src_factor));
 217                         blend_attachments[i].dstColorBlendFactor = static_cast<VkBlendFactor>(get_vulkan_blend_factor(blend->dst_factor));
 218                         blend_attachments[i].colorBlendOp = static_cast<VkBlendOp>(get_vulkan_blend_equation(blend->equation));
 219                         blend_attachments[i].srcAlphaBlendFactor = blend_attachments[i].srcColorBlendFactor;
 220                         blend_attachments[i].dstAlphaBlendFactor = blend_attachments[i].dstColorBlendFactor;
 221                         blend_attachments[i].alphaBlendOp = blend_attachments[i].colorBlendOp;
 222                         blend_attachments[i].colorWriteMask = get_vulkan_color_mask(blend->write_mask);
 223                 }
 224         }
 225         else
 226         {
 227                 for(unsigned i=0; i<n_color_attachments; ++i)
 228                         blend_attachments[i].colorWriteMask = VK_COLOR_COMPONENT_R_BIT|VK_COLOR_COMPONENT_G_BIT|VK_COLOR_COMPONENT_B_BIT|VK_COLOR_COMPONENT_A_BIT;
 229         }
 230
 231         blend_info->sType = VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO;
 232         blend_info->attachmentCount = n_color_attachments;
 233         blend_info->pAttachments = blend_attachments;
 234
 235         dynamic_states[0] = VK_DYNAMIC_STATE_VIEWPORT;
 236         dynamic_states[1] = VK_DYNAMIC_STATE_SCISSOR;
 237
 238         dynamic_info->sType = VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO;
 239         dynamic_info->dynamicStateCount = 2;
 240         dynamic_info->pDynamicStates = dynamic_states;
 241
 242         pipeline_info->sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO;
 243
 244         pipeline_info->pInputAssemblyState = input_assembly_info;
 245         pipeline_info->pTessellationState = 0;
 246         pipeline_info->pViewportState = viewport_info;
 247         pipeline_info->pRasterizationState = raster_info;
 248         pipeline_info->pMultisampleState = multisample_info;
 249         pipeline_info->pDepthStencilState = depth_stencil_info;
 250         pipeline_info->pColorBlendState = blend_info;
 251         pipeline_info->pDynamicState = dynamic_info;
 252         pipeline_info->renderPass = handle_cast<::VkRenderPass>(render_pass);
 253         pipeline_info->subpass = 0;
 254
 255         if(self.shprog)
 256         {
 257                 pipeline_info->stageCount = self.shprog->n_stages;
 258                 pipeline_info->pStages = reinterpret_cast<const VkPipelineShaderStageCreateInfo *>(self.shprog->creation_info.data());
 259                 pipeline_info->layout = handle_cast<::VkPipelineLayout>(self.shprog->layout_handle);
 260         }
 261
 262         if(self.vertex_setup)
 263                 pipeline_info->pVertexInputState = reinterpret_cast<const VkPipelineVertexInputStateCreateInfo *>(self.vertex_setup->creation_info.data());
 264 }
 265
 266 uint64_t VulkanPipelineState::compute_descriptor_set_hash(unsigned index) const
 267 {
 268         const PipelineState &self = *static_cast<const PipelineState *>(this);
 269
 270         uint64_t result = hash<64>(0, 0);
 271         for(const PipelineState::BoundUniformBlock &b: self.uniform_blocks)
 272                 if(b.used && b.binding>=0 && static_cast<unsigned>(b.binding>>20)==index)
 273                 {
 274                         result = hash_update<64>(result, b.binding);
 275                         result = hash_update<64>(result, reinterpret_cast<uintptr_t>(b.block));
 276                 }
 277         for(const PipelineState::BoundTexture &t: self.textures)
 278                 if(t.used && (t.binding>>20)==index)
 279                 {
 280                         result = hash_update<64>(result, t.binding);
 281                         result = hash_update<64>(result, reinterpret_cast<uintptr_t>(t.texture));
 282                         result = hash_update<64>(result, reinterpret_cast<uintptr_t>(t.sampler));
 283                 }
 284
 285         return result;
 286 }
 287
 288 VkDescriptorSetLayout VulkanPipelineState::get_descriptor_set_layout(unsigned index) const
 289 {
 290         return static_cast<const PipelineState *>(this)->shprog->desc_set_layout_handles[index];
 291 }
 292
 293 unsigned VulkanPipelineState::fill_descriptor_writes(unsigned index, vector<char> &buffer) const
 294 {
 295         const PipelineState &self = *static_cast<const PipelineState *>(this);
 296
 297         unsigned n_buffers = 0;
 298         for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
 299                 if(u.used && u.binding>=0 && static_cast<unsigned>(u.binding>>20)==index)
 300                         ++n_buffers;
 301         unsigned n_images = 0;
 302         for(const PipelineState::BoundTexture &t: self.textures)
 303                 if(t.used && (t.binding>>20)==index)
 304                         ++n_images;
 305         unsigned n_writes = n_buffers+n_images;
 306
 307         StructureBuilder sb(buffer, 3);
 308         VkWriteDescriptorSet *&writes = sb.add<VkWriteDescriptorSet>(n_writes);
 309         VkDescriptorBufferInfo *&buffers = sb.add<VkDescriptorBufferInfo>(n_buffers);
 310         VkDescriptorImageInfo *&images = sb.add<VkDescriptorImageInfo>(n_images);
 311
 312         VkWriteDescriptorSet *write_ptr = writes;
 313         VkDescriptorBufferInfo *buffer_ptr = buffers;
 314         VkDescriptorImageInfo *image_ptr = images;
 315
 316         for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
 317                 if(u.used && u.binding>=0 && static_cast<unsigned>(u.binding>>20)==index)
 318                 {
 319                         buffer_ptr->buffer = handle_cast<::VkBuffer>(u.block->get_buffer()->handle);
 320                         buffer_ptr->offset = u.block->get_offset();
 321                         buffer_ptr->range = u.block->get_data_size();
 322
 323                         write_ptr->sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
 324                         write_ptr->dstBinding = u.binding&0xFFFFF;
 325                         write_ptr->descriptorCount = 1;
 326                         write_ptr->descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
 327                         write_ptr->pBufferInfo = buffer_ptr;
 328
 329                         ++buffer_ptr;
 330                         ++write_ptr;
 331                 }
 332
 333         for(const PipelineState::BoundTexture &t: self.textures)
 334                 if(t.used && (t.binding>>20)==index)
 335                 {
 336                         image_ptr->sampler = handle_cast<::VkSampler>(t.sampler->handle);
 337                         image_ptr->imageView = handle_cast<::VkImageView>(t.texture->view_handle);
 338                         image_ptr->imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
 339
 340                         write_ptr->sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
 341                         write_ptr->dstBinding = t.binding&0xFFFFF;
 342                         write_ptr->descriptorCount = 1;
 343                         write_ptr->descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
 344                         write_ptr->pImageInfo = image_ptr;
 345
 346                         ++image_ptr;
 347                         ++write_ptr;
 348                 }
 349
 350         return n_writes;
 351 }
 352
 353 void VulkanPipelineState::apply(VkCommandBuffer command_buffer) const
 354 {
 355         const PipelineState &self = *static_cast<const PipelineState *>(this);
 356         const VulkanFunctions &vk = device.get_functions();
 357
 358         vk.CmdBindPipeline(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, handle);
 359         if(const VertexSetup *vs = self.vertex_setup)
 360         {
 361                 vk.CmdBindVertexBuffers(command_buffer, 0, vs->n_bindings, vs->buffers, vs->offsets);
 362                 VkIndexType index_type = static_cast<VkIndexType>(get_vulkan_index_type(vs->get_index_type()));
 363                 vk.CmdBindIndexBuffer(command_buffer, vs->get_index_buffer()->handle, 0, index_type);
 364         }
 365
 366         if(!self.uniform_blocks.empty())
 367         {
 368                 const PipelineState::BoundUniformBlock &first_block = self.uniform_blocks.front();
 369                 if(first_block.used && first_block.binding==ReflectData::PUSH_CONSTANT)
 370                 {
 371                         const UniformBlock &pc_block = *first_block.block;
 372                         vk.CmdPushConstants(command_buffer, self.shprog->layout_handle, self.shprog->stage_flags,
 373                                 pc_block.get_offset(), pc_block.get_data_size(), pc_block.get_data_pointer());
 374                 }
 375         }
 376
 377         if(!descriptor_set_handles.empty())
 378                 vk.CmdBindDescriptorSets(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, self.shprog->layout_handle, 0, descriptor_set_handles.size(), descriptor_set_handles.data(), 0, 0);
 379
 380         VkViewport viewport = { };
 381         if(self.viewport)
 382         {
 383                 viewport.x = self.viewport->left;
 384                 viewport.y = self.framebuffer->get_height()-(self.viewport->bottom+self.viewport->height);
 385                 viewport.width = self.viewport->width;
 386                 viewport.height = self.viewport->height;
 387         }
 388         else
 389         {
 390                 viewport.x = 0;
 391                 viewport.y = 0;
 392                 viewport.width = self.framebuffer->get_width();
 393                 viewport.height = self.framebuffer->get_height();
 394         }
 395         viewport.minDepth = 0.0f;
 396         viewport.maxDepth = 1.0f;
 397         vk.CmdSetViewport(command_buffer, 0, 1, &viewport);
 398
 399         VkRect2D scissor = { };
 400         if(self.scissor)
 401         {
 402                 scissor.offset.x = self.scissor->left;
 403                 scissor.offset.y = self.framebuffer->get_height()-(self.scissor->bottom+self.scissor->height);
 404                 scissor.extent.width = self.scissor->width;
 405                 scissor.extent.height = self.scissor->height;
 406         }
 407         else
 408         {
 409                 scissor.offset.x = 0;
 410                 scissor.offset.y = 0;
 411                 scissor.extent.width = self.framebuffer->get_width();
 412                 scissor.extent.height = self.framebuffer->get_height();
 413         }
 414         vk.CmdSetScissor(command_buffer, 0, 1, &scissor);
 415 }
 416
 417 } // namespace GL
 418 } // namespace Msp