1 #include <msp/core/hash.h>
7 #include "framebuffer.h"
8 #include "pipelinestate.h"
9 #include "pipelinestate_backend.h"
13 #include "stenciltest.h"
14 #include "structurebuilder.h"
16 #include "uniformblock.h"
17 #include "vertexsetup.h"
25 VulkanPipelineState::VulkanPipelineState():
26 device(Device::get_current())
29 VulkanPipelineState::VulkanPipelineState(VulkanPipelineState &&other):
34 void VulkanPipelineState::update() const
36 const PipelineState &self = *static_cast<const PipelineState *>(this);
38 unapplied |= changes&(PipelineState::VIEWPORT|PipelineState::SCISSOR|PipelineState::VERTEX_SETUP);
40 if(changes&PipelineState::VERTEX_SETUP)
41 self.vertex_setup->refresh();
43 constexpr unsigned pipeline_mask = PipelineState::SHPROG|PipelineState::VERTEX_SETUP|PipelineState::FACE_CULL|
44 PipelineState::DEPTH_TEST|PipelineState::STENCIL_TEST|PipelineState::BLEND|PipelineState::PRIMITIVE_TYPE;
45 if(changes&pipeline_mask)
47 handle = device.get_pipeline_cache().get_pipeline(self);
48 unapplied |= PipelineState::SHPROG;
51 if(changes&(PipelineState::SHPROG|PipelineState::UNIFORMS|PipelineState::TEXTURES))
53 unsigned changed_sets = (changes&PipelineState::SHPROG ? ~0U : 0U);
54 for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
55 if(u.changed || changed_sets==~0U)
58 u.used = self.shprog->uses_uniform_block_binding(u.binding);
60 changed_sets |= 1<<(u.binding>>20);
63 for(const PipelineState::BoundTexture &t: self.textures)
64 if(t.changed || changed_sets==~0U)
66 if(t.texture && t.sampler)
67 t.used = self.shprog->uses_texture_binding(t.binding);
68 changed_sets |= 1<<(t.binding>>20);
69 if(t.texture && t.level>=0)
70 t.texture->refresh_mip_views();
78 descriptor_set_handles.resize(self.shprog->get_n_descriptor_sets());
79 for(unsigned i=0; i<descriptor_set_handles.size(); ++i)
80 if(changed_sets&(1<<i))
81 descriptor_set_handles[i] = device.get_pipeline_cache().get_descriptor_set(self, i);
82 unapplied |= PipelineState::UNIFORMS;
89 uint64_t VulkanPipelineState::compute_hash() const
91 const PipelineState &self = *static_cast<const PipelineState *>(this);
92 const FrameFormat &format = self.framebuffer->get_format();
94 uint64_t result = hash<64>(self.shprog);
95 result = hash_update<64>(result, self.vertex_setup->compute_hash());
96 result = hash_round<64>(result, self.primitive_type);
98 if(self.front_face!=NON_MANIFOLD && self.face_cull!=NO_CULL)
100 result = hash_round<64>(result, self.front_face);
101 result = hash_round<64>(result, self.face_cull);
104 result = hash_round<64>(result, format.get_samples());
106 if(self.depth_test.enabled)
108 result = hash_round<64>(result, self.depth_test.compare);
109 result = hash_update<64>(result, self.depth_test.write);
112 if(self.stencil_test.enabled)
114 result = hash_round<64>(result, self.stencil_test.compare);
115 result = hash_round<64>(result, self.stencil_test.stencil_fail_op);
116 result = hash_round<64>(result, self.stencil_test.depth_fail_op);
117 result = hash_round<64>(result, self.stencil_test.depth_pass_op);
118 result = hash_update<64>(result, self.stencil_test.reference);
121 if(self.blend.enabled)
123 result = hash_round<64>(result, self.blend.equation);
124 result = hash_round<64>(result, self.blend.src_factor);
125 result = hash_round<64>(result, self.blend.dst_factor);
126 result = hash_round<64>(result, self.blend.write_mask);
129 for(FrameAttachment a: format)
130 result = hash_update<64>(result, a);
135 void VulkanPipelineState::fill_creation_info(vector<char> &buffer) const
137 const PipelineState &self = *static_cast<const PipelineState *>(this);
139 const FrameFormat &format = self.framebuffer->get_format();
140 VkRenderPass render_pass = device.get_pipeline_cache().get_render_pass(format, false, false, false);
142 unsigned n_color_attachments = 0;
143 for(FrameAttachment a: format)
145 unsigned attach_pt = get_attach_point(a);
146 if(attach_pt!=get_attach_point(DEPTH_ATTACHMENT) && attach_pt!=get_attach_point(STENCIL_ATTACHMENT))
147 ++n_color_attachments;
150 StructureBuilder sb(buffer, 10);
151 VkGraphicsPipelineCreateInfo *&pipeline_info = sb.add<VkGraphicsPipelineCreateInfo>();
152 VkPipelineInputAssemblyStateCreateInfo *&input_assembly_info = sb.add<VkPipelineInputAssemblyStateCreateInfo>();
153 VkPipelineViewportStateCreateInfo *&viewport_info = sb.add<VkPipelineViewportStateCreateInfo>();
154 VkPipelineRasterizationStateCreateInfo *&raster_info = sb.add<VkPipelineRasterizationStateCreateInfo>();
155 VkPipelineMultisampleStateCreateInfo *&multisample_info = sb.add<VkPipelineMultisampleStateCreateInfo>();
156 VkPipelineDepthStencilStateCreateInfo *&depth_stencil_info = sb.add<VkPipelineDepthStencilStateCreateInfo>();
157 VkPipelineColorBlendStateCreateInfo *&blend_info = sb.add<VkPipelineColorBlendStateCreateInfo>();
158 VkPipelineColorBlendAttachmentState *&blend_attachments = sb.add<VkPipelineColorBlendAttachmentState>(n_color_attachments);
159 VkPipelineDynamicStateCreateInfo *&dynamic_info = sb.add<VkPipelineDynamicStateCreateInfo>();
160 VkDynamicState *&dynamic_states = sb.add<VkDynamicState>(2);
162 input_assembly_info->sType = VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO;
163 input_assembly_info->topology = static_cast<VkPrimitiveTopology>(get_vulkan_primitive_type(self.primitive_type));
164 input_assembly_info->primitiveRestartEnable = true;
166 viewport_info->sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO;
167 viewport_info->viewportCount = 1;
168 viewport_info->pViewports = 0;
169 viewport_info->scissorCount = 1;
170 viewport_info->pScissors = 0;
172 raster_info->sType = VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO;
173 raster_info->depthClampEnable = VK_FALSE;
174 raster_info->rasterizerDiscardEnable = VK_FALSE;
175 raster_info->polygonMode = VK_POLYGON_MODE_FILL;
176 raster_info->frontFace = (self.front_face==CLOCKWISE ? VK_FRONT_FACE_COUNTER_CLOCKWISE : VK_FRONT_FACE_CLOCKWISE);
177 if(self.face_cull==NO_CULL || self.front_face==NON_MANIFOLD)
178 raster_info->cullMode = VK_CULL_MODE_NONE;
180 raster_info->cullMode = (self.face_cull==CULL_FRONT ? VK_CULL_MODE_FRONT_BIT : VK_CULL_MODE_BACK_BIT);
181 raster_info->depthBiasEnable = VK_FALSE;
182 raster_info->depthBiasConstantFactor = 0.0f;
183 raster_info->depthBiasClamp = 0.0f;
184 raster_info->depthBiasSlopeFactor = 0.0f;
185 raster_info->lineWidth = 1.0f;
187 multisample_info->sType = VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO;
188 multisample_info->rasterizationSamples = static_cast<VkSampleCountFlagBits>(get_vulkan_samples(format.get_samples()));
189 multisample_info->sampleShadingEnable = VK_FALSE;
190 multisample_info->minSampleShading = 1.0f;
191 multisample_info->pSampleMask = 0;
192 multisample_info->alphaToCoverageEnable = VK_FALSE;
193 multisample_info->alphaToOneEnable = VK_FALSE;
195 depth_stencil_info->sType = VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO;
196 depth_stencil_info->depthTestEnable = self.depth_test.enabled;
197 depth_stencil_info->depthWriteEnable = self.depth_test.write;
198 depth_stencil_info->depthCompareOp = static_cast<VkCompareOp>(get_vulkan_predicate(self.depth_test.compare));
199 depth_stencil_info->depthBoundsTestEnable = VK_FALSE;
201 depth_stencil_info->stencilTestEnable = self.stencil_test.enabled;
202 depth_stencil_info->front.failOp = static_cast<VkStencilOp>(get_vulkan_stencil_op(self.stencil_test.stencil_fail_op));
203 depth_stencil_info->front.passOp = static_cast<VkStencilOp>(get_vulkan_stencil_op(self.stencil_test.depth_pass_op));
204 depth_stencil_info->front.depthFailOp = static_cast<VkStencilOp>(get_vulkan_stencil_op(self.stencil_test.depth_fail_op));
205 depth_stencil_info->front.compareOp = static_cast<VkCompareOp>(get_vulkan_predicate(self.stencil_test.compare));
206 depth_stencil_info->front.compareMask = 0xFFFFFFFFU;
207 depth_stencil_info->front.writeMask = 0xFFFFFFFFU;
208 depth_stencil_info->front.reference = self.stencil_test.reference;
209 depth_stencil_info->back = depth_stencil_info->front;
211 for(unsigned i=0; i<n_color_attachments; ++i)
213 blend_attachments[i].blendEnable = self.blend.enabled;
214 blend_attachments[i].srcColorBlendFactor = static_cast<VkBlendFactor>(get_vulkan_blend_factor(self.blend.src_factor));
215 blend_attachments[i].dstColorBlendFactor = static_cast<VkBlendFactor>(get_vulkan_blend_factor(self.blend.dst_factor));
216 blend_attachments[i].colorBlendOp = static_cast<VkBlendOp>(get_vulkan_blend_equation(self.blend.equation));
217 blend_attachments[i].srcAlphaBlendFactor = blend_attachments[i].srcColorBlendFactor;
218 blend_attachments[i].dstAlphaBlendFactor = blend_attachments[i].dstColorBlendFactor;
219 blend_attachments[i].alphaBlendOp = blend_attachments[i].colorBlendOp;
220 blend_attachments[i].colorWriteMask = get_vulkan_color_mask(self.blend.write_mask);
223 blend_info->sType = VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO;
224 blend_info->attachmentCount = n_color_attachments;
225 blend_info->pAttachments = blend_attachments;
227 dynamic_states[0] = VK_DYNAMIC_STATE_VIEWPORT;
228 dynamic_states[1] = VK_DYNAMIC_STATE_SCISSOR;
230 dynamic_info->sType = VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO;
231 dynamic_info->dynamicStateCount = 2;
232 dynamic_info->pDynamicStates = dynamic_states;
234 pipeline_info->sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO;
236 pipeline_info->pInputAssemblyState = input_assembly_info;
237 pipeline_info->pTessellationState = 0;
238 pipeline_info->pViewportState = viewport_info;
239 pipeline_info->pRasterizationState = raster_info;
240 pipeline_info->pMultisampleState = multisample_info;
241 pipeline_info->pDepthStencilState = depth_stencil_info;
242 pipeline_info->pColorBlendState = blend_info;
243 pipeline_info->pDynamicState = dynamic_info;
244 pipeline_info->renderPass = handle_cast<::VkRenderPass>(render_pass);
245 pipeline_info->subpass = 0;
249 pipeline_info->stageCount = self.shprog->n_stages;
250 pipeline_info->pStages = reinterpret_cast<const VkPipelineShaderStageCreateInfo *>(self.shprog->creation_info.data());
251 pipeline_info->layout = handle_cast<::VkPipelineLayout>(self.shprog->layout_handle);
254 if(self.vertex_setup)
255 pipeline_info->pVertexInputState = reinterpret_cast<const VkPipelineVertexInputStateCreateInfo *>(self.vertex_setup->creation_info.data());
258 uint64_t VulkanPipelineState::compute_descriptor_set_hash(unsigned index) const
260 const PipelineState &self = *static_cast<const PipelineState *>(this);
262 uint64_t result = hash<64>(0, 0);
263 for(const PipelineState::BoundUniformBlock &b: self.uniform_blocks)
264 if(b.used && b.binding>=0 && static_cast<unsigned>(b.binding>>20)==index)
266 result = hash_update<64>(result, b.binding);
267 result = hash_update<64>(result, reinterpret_cast<uintptr_t>(b.block));
268 result = hash_update<64>(result, reinterpret_cast<uintptr_t>(b.buffer->handle));
270 for(const PipelineState::BoundTexture &t: self.textures)
271 if(t.used && (t.binding>>20)==index)
273 result = hash_update<64>(result, t.binding);
274 result = hash_update<64>(result, reinterpret_cast<uintptr_t>(t.texture->handle));
275 result = hash_update<64>(result, reinterpret_cast<uintptr_t>(t.sampler->handle));
276 result = hash_update<64>(result, t.level);
282 VkDescriptorSetLayout VulkanPipelineState::get_descriptor_set_layout(unsigned index) const
284 return static_cast<const PipelineState *>(this)->shprog->desc_set_layout_handles[index];
287 unsigned VulkanPipelineState::fill_descriptor_writes(unsigned index, vector<char> &buffer) const
289 const PipelineState &self = *static_cast<const PipelineState *>(this);
291 unsigned n_buffers = 0;
292 for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
293 if(u.used && u.binding>=0 && static_cast<unsigned>(u.binding>>20)==index)
295 unsigned n_images = 0;
296 for(const PipelineState::BoundTexture &t: self.textures)
297 if(t.used && (t.binding>>20)==index)
299 unsigned n_writes = n_buffers+n_images;
301 StructureBuilder sb(buffer, 3);
302 VkWriteDescriptorSet *&writes = sb.add<VkWriteDescriptorSet>(n_writes);
303 VkDescriptorBufferInfo *&buffers = sb.add<VkDescriptorBufferInfo>(n_buffers);
304 VkDescriptorImageInfo *&images = sb.add<VkDescriptorImageInfo>(n_images);
306 VkWriteDescriptorSet *write_ptr = writes;
307 VkDescriptorBufferInfo *buffer_ptr = buffers;
308 VkDescriptorImageInfo *image_ptr = images;
310 for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
311 if(u.used && u.binding>=0 && static_cast<unsigned>(u.binding>>20)==index)
313 buffer_ptr->buffer = handle_cast<::VkBuffer>(u.buffer->handle);
314 buffer_ptr->offset = u.block->get_offset();
315 buffer_ptr->range = u.block->get_data_size();
317 write_ptr->sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
318 write_ptr->dstBinding = u.binding&0xFFFFF;
319 write_ptr->descriptorCount = 1;
320 write_ptr->descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC;
321 write_ptr->pBufferInfo = buffer_ptr;
327 for(const PipelineState::BoundTexture &t: self.textures)
328 if(t.used && (t.binding>>20)==index)
330 image_ptr->sampler = handle_cast<::VkSampler>(t.sampler->handle);
332 image_ptr->imageView = handle_cast<::VkImageView>(t.texture->view_handle);
334 image_ptr->imageView = handle_cast<::VkImageView>(t.texture->mip_view_handles[t.level]);
335 image_ptr->imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
337 write_ptr->sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
338 write_ptr->dstBinding = t.binding&0xFFFFF;
339 write_ptr->descriptorCount = 1;
340 write_ptr->descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
341 write_ptr->pImageInfo = image_ptr;
350 void VulkanPipelineState::apply(VkCommandBuffer command_buffer, const VulkanPipelineState *last, unsigned frame, bool negative_viewport) const
352 const PipelineState &self = *static_cast<const PipelineState *>(this);
353 const VulkanFunctions &vk = device.get_functions();
359 const PipelineState &last_ps = *static_cast<const PipelineState *>(last);
360 if(handle!=last->handle)
361 unapplied |= PipelineState::SHPROG;
362 if(self.vertex_setup!=last_ps.vertex_setup)
363 unapplied |= PipelineState::VERTEX_SETUP;
364 for(unsigned i=0; (i<descriptor_set_handles.size() && i<last->descriptor_set_handles.size()); ++i)
365 if(descriptor_set_handles[i]!=last->descriptor_set_handles[i])
367 unapplied |= PipelineState::UNIFORMS;
370 if(self.viewport!=last_ps.viewport)
371 unapplied |= PipelineState::VIEWPORT;
372 if(self.scissor!=last_ps.scissor)
373 unapplied |= PipelineState::SCISSOR;
376 if(unapplied&PipelineState::SHPROG)
377 vk.CmdBindPipeline(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, handle);
379 if(unapplied&PipelineState::VERTEX_SETUP)
380 if(const VertexSetup *vs = self.vertex_setup)
382 vk.CmdBindVertexBuffers(command_buffer, 0, vs->n_bindings, vs->buffers, vs->offsets);
383 VkIndexType index_type = static_cast<VkIndexType>(get_vulkan_index_type(vs->get_index_type()));
384 vk.CmdBindIndexBuffer(command_buffer, vs->get_index_buffer()->handle, 0, index_type);
387 if(!self.uniform_blocks.empty())
389 const PipelineState::BoundUniformBlock &first_block = self.uniform_blocks.front();
390 if(first_block.used && first_block.binding==ReflectData::PUSH_CONSTANT)
392 const UniformBlock &pc_block = *first_block.block;
393 vk.CmdPushConstants(command_buffer, self.shprog->layout_handle, self.shprog->stage_flags,
394 pc_block.get_offset(), pc_block.get_data_size(), pc_block.get_data_pointer());
398 if((unapplied&PipelineState::UNIFORMS) && !descriptor_set_handles.empty())
400 vector<uint32_t> dynamic_offsets;
401 dynamic_offsets.reserve(self.uniform_blocks.size());
402 for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
403 if(u.used && u.binding>=0)
405 if(u.buffer->get_usage()==STREAMING)
406 dynamic_offsets.push_back(frame*u.buffer->get_size());
408 dynamic_offsets.push_back(0);
411 vk.CmdBindDescriptorSets(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, self.shprog->layout_handle,
412 0, descriptor_set_handles.size(), descriptor_set_handles.data(), dynamic_offsets.size(), dynamic_offsets.data());
415 if(unapplied&(PipelineState::VIEWPORT|PipelineState::SCISSOR))
417 Rect fb_rect = self.framebuffer->get_rect();
419 if(unapplied&PipelineState::VIEWPORT)
421 Rect viewport_rect = fb_rect.intersect(self.viewport);
422 VkViewport viewport = { };
423 viewport.x = viewport_rect.left;
424 viewport.y = viewport_rect.bottom;
425 viewport.width = viewport_rect.width;
426 viewport.height = viewport_rect.height;
427 if(negative_viewport)
429 viewport.y += viewport.height;
430 viewport.height = -viewport.height;
432 viewport.minDepth = 0.0f;
433 viewport.maxDepth = 1.0f;
434 vk.CmdSetViewport(command_buffer, 0, 1, &viewport);
437 if(unapplied&PipelineState::SCISSOR)
439 Rect scissor_rect = fb_rect.intersect(self.scissor);
440 VkRect2D scissor = { };
441 scissor.offset.x = scissor_rect.left;
442 scissor.offset.y = scissor_rect.bottom;
443 scissor.extent.width = scissor_rect.width;
444 scissor.extent.height = scissor_rect.height;
445 vk.CmdSetScissor(command_buffer, 0, 1, &scissor);