Blender V5.3
vk_command_buffer_wrapper.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2024 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "vk_common.hh"
12
13namespace blender {
14
15namespace gpu {
16struct VKExtensions;
17struct VKWorkarounds;
18} // namespace gpu
19
20namespace gpu::render_graph {
22 public:
26
28 virtual ~VKCommandBufferInterface() = default;
29
30 virtual void begin_recording() = 0;
31 virtual void end_recording() = 0;
32
33 virtual void bind_pipeline(VkPipelineBindPoint pipeline_bind_point, VkPipeline pipeline) = 0;
34 virtual void bind_descriptor_sets(VkPipelineBindPoint pipeline_bind_point,
35 VkPipelineLayout layout,
36 uint32_t first_set,
37 uint32_t descriptor_set_count,
38 const VkDescriptorSet *p_descriptor_sets,
39 uint32_t dynamic_offset_count,
40 const uint32_t *p_dynamic_offsets) = 0;
41 virtual void bind_index_buffer(VkBuffer buffer, VkDeviceSize offset, VkIndexType index_type) = 0;
42 virtual void bind_vertex_buffers(uint32_t first_binding,
43 uint32_t binding_count,
44 const VkBuffer *p_buffers,
45 const VkDeviceSize *p_offsets) = 0;
46 virtual void draw(uint32_t vertex_count,
47 uint32_t instance_count,
48 uint32_t first_vertex,
49 uint32_t first_instance) = 0;
50 virtual void draw_indexed(uint32_t index_count,
51 uint32_t instance_count,
52 uint32_t first_index,
53 int32_t vertex_offset,
54 uint32_t first_instance) = 0;
55 virtual void draw_indirect(VkBuffer buffer,
56 VkDeviceSize offset,
57 uint32_t draw_count,
58 uint32_t stride) = 0;
59 virtual void draw_indexed_indirect(VkBuffer buffer,
60 VkDeviceSize offset,
61 uint32_t draw_count,
62 uint32_t stride) = 0;
63 virtual void dispatch(uint32_t group_count_x,
64 uint32_t group_count_y,
65 uint32_t group_count_z) = 0;
66 virtual void dispatch_indirect(VkBuffer buffer, VkDeviceSize offset) = 0;
67 virtual void update_buffer(VkBuffer dst_buffer,
68 VkDeviceSize dst_offset,
69 VkDeviceSize data_size,
70 const void *p_data) = 0;
71 virtual void copy_buffer(VkBuffer src_buffer,
72 VkBuffer dst_buffer,
73 uint32_t region_count,
74 const VkBufferCopy *p_regions) = 0;
75 virtual void copy_image(VkImage src_image,
76 VkImageLayout src_image_layout,
77 VkImage dst_image,
78 VkImageLayout dst_image_layout,
79 uint32_t region_count,
80 const VkImageCopy *p_regions) = 0;
81 virtual void blit_image(VkImage src_image,
82 VkImageLayout src_image_layout,
83 VkImage dst_image,
84 VkImageLayout dst_image_layout,
85 uint32_t region_count,
86 const VkImageBlit *p_regions,
87 VkFilter filter) = 0;
88 virtual void copy_buffer_to_image(VkBuffer src_buffer,
89 VkImage dst_image,
90 VkImageLayout dst_image_layout,
91 uint32_t region_count,
92 const VkBufferImageCopy *p_regions) = 0;
93 virtual void copy_image_to_buffer(VkImage src_image,
94 VkImageLayout src_image_layout,
95 VkBuffer dst_buffer,
96 uint32_t region_count,
97 const VkBufferImageCopy *p_regions) = 0;
98 virtual void fill_buffer(VkBuffer dst_buffer,
99 VkDeviceSize dst_offset,
100 VkDeviceSize size,
101 uint32_t data) = 0;
102 virtual void clear_color_image(VkImage image,
103 VkImageLayout image_layout,
104 const VkClearColorValue *p_color,
105 uint32_t range_count,
106 const VkImageSubresourceRange *p_ranges) = 0;
107 virtual void clear_depth_stencil_image(VkImage image,
108 VkImageLayout image_layout,
109 const VkClearDepthStencilValue *p_depth_stencil,
110 uint32_t range_count,
111 const VkImageSubresourceRange *p_ranges) = 0;
112 virtual void clear_attachments(uint32_t attachment_count,
113 const VkClearAttachment *p_attachments,
114 uint32_t rect_count,
115 const VkClearRect *p_rects) = 0;
116 virtual void pipeline_barrier(VkPipelineStageFlags src_stage_mask,
117 VkPipelineStageFlags dst_stage_mask,
118 VkDependencyFlags dependency_flags,
119 uint32_t memory_barrier_count,
120 const VkMemoryBarrier *p_memory_barriers,
121 uint32_t buffer_memory_barrier_count,
122 const VkBufferMemoryBarrier *p_buffer_memory_barriers,
123 uint32_t image_memory_barrier_count,
124 const VkImageMemoryBarrier *p_image_memory_barriers) = 0;
125 virtual void push_constants(VkPipelineLayout layout,
126 VkShaderStageFlags stage_flags,
127 uint32_t offset,
128 uint32_t size,
129 const void *p_values) = 0;
130 virtual void begin_query(VkQueryPool vk_query_pool,
131 uint32_t query_index,
132 VkQueryControlFlags vk_query_control_flags) = 0;
133 virtual void end_query(VkQueryPool vk_query_pool, uint32_t query_index) = 0;
134 virtual void reset_query_pool(VkQueryPool vk_query_pool,
135 uint32_t first_query,
136 uint32_t query_count) = 0;
137 /* Dynamic states. */
138
139 virtual void set_viewport(const Vector<VkViewport> viewports) = 0;
140 virtual void set_scissor(const Vector<VkRect2D> scissors) = 0;
141 virtual void set_line_width(const float line_width) = 0;
142 virtual void set_stencil_compare_mask(const uint32_t compare_mask) = 0;
143 virtual void set_stencil_write_mask(const uint32_t write_mask) = 0;
144 virtual void set_stencil_reference(const uint32_t reference) = 0;
145 /* VK_EXT_extended_dynamic_state */
146 virtual void set_front_face(const VkFrontFace front_face) = 0;
147 /* VK_EXT_vertex_input_dynamic_state */
148 virtual void set_vertex_input(
149 Span<VkVertexInputBindingDescription2EXT> vertex_binding_descriptions,
150 Span<VkVertexInputAttributeDescription2EXT> vertex_attribute_descriptions) = 0;
151 /* VK_KHR_dynamic_rendering */
152 virtual void begin_rendering(const VkRenderingInfo *p_rendering_info) = 0;
153 virtual void end_rendering() = 0;
154 /* VK_EXT_debug_utils */
155 virtual void begin_debug_utils_label(const VkDebugUtilsLabelEXT *vk_debug_utils_label) = 0;
156 virtual void end_debug_utils_label() = 0;
157
158 /* VK_KHR_ray_tracing */
160 const VkAccelerationStructureBuildGeometryInfoKHR *p_infos,
161 const VkAccelerationStructureBuildRangeInfoKHR *p_build_range_infos) = 0;
162};
163
165 private:
166 VkCommandBuffer vk_command_buffer_ = VK_NULL_HANDLE;
167 const VolkDeviceTable *functions = nullptr;
168
169 public:
170 VKCommandBufferWrapper(VkCommandBuffer vk_command_buffer,
171 const VolkDeviceTable &functions,
172 const VKExtensions &extensions,
173 const VKWorkarounds &workarounds);
174
175 void begin_recording() override;
176 void end_recording() override;
177
178 void bind_pipeline(VkPipelineBindPoint pipeline_bind_point, VkPipeline pipeline) override;
179 void bind_descriptor_sets(VkPipelineBindPoint pipeline_bind_point,
180 VkPipelineLayout layout,
181 uint32_t first_set,
182 uint32_t descriptor_set_count,
183 const VkDescriptorSet *p_descriptor_sets,
184 uint32_t dynamic_offset_count,
185 const uint32_t *p_dynamic_offsets) override;
186 void bind_index_buffer(VkBuffer buffer, VkDeviceSize offset, VkIndexType index_type) override;
187 void bind_vertex_buffers(uint32_t first_binding,
188 uint32_t binding_count,
189 const VkBuffer *p_buffers,
190 const VkDeviceSize *p_offsets) override;
191 void draw(uint32_t vertex_count,
192 uint32_t instance_count,
193 uint32_t first_vertex,
194 uint32_t first_instance) override;
195 void draw_indexed(uint32_t index_count,
196 uint32_t instance_count,
197 uint32_t first_index,
198 int32_t vertex_offset,
199 uint32_t first_instance) override;
200 void draw_indirect(VkBuffer buffer,
201 VkDeviceSize offset,
202 uint32_t draw_count,
203 uint32_t stride) override;
204 void draw_indexed_indirect(VkBuffer buffer,
205 VkDeviceSize offset,
206 uint32_t draw_count,
207 uint32_t stride) override;
208 void dispatch(uint32_t group_count_x, uint32_t group_count_y, uint32_t group_count_z) override;
209 void dispatch_indirect(VkBuffer buffer, VkDeviceSize offset) override;
210 void update_buffer(VkBuffer dst_buffer,
211 VkDeviceSize dst_offset,
212 VkDeviceSize data_size,
213 const void *p_data) override;
214 void copy_buffer(VkBuffer src_buffer,
215 VkBuffer dst_buffer,
216 uint32_t region_count,
217 const VkBufferCopy *p_regions) override;
218 void copy_image(VkImage src_image,
219 VkImageLayout src_image_layout,
220 VkImage dst_image,
221 VkImageLayout dst_image_layout,
222 uint32_t region_count,
223 const VkImageCopy *p_regions) override;
224 void blit_image(VkImage src_image,
225 VkImageLayout src_image_layout,
226 VkImage dst_image,
227 VkImageLayout dst_image_layout,
228 uint32_t region_count,
229 const VkImageBlit *p_regions,
230 VkFilter filter) override;
231 void copy_buffer_to_image(VkBuffer src_buffer,
232 VkImage dst_image,
233 VkImageLayout dst_image_layout,
234 uint32_t region_count,
235 const VkBufferImageCopy *p_regions) override;
236 void copy_image_to_buffer(VkImage src_image,
237 VkImageLayout src_image_layout,
238 VkBuffer dst_buffer,
239 uint32_t region_count,
240 const VkBufferImageCopy *p_regions) override;
241 void fill_buffer(VkBuffer dst_buffer,
242 VkDeviceSize dst_offset,
243 VkDeviceSize size,
244 uint32_t data) override;
245 void clear_color_image(VkImage image,
246 VkImageLayout image_layout,
247 const VkClearColorValue *p_color,
248 uint32_t range_count,
249 const VkImageSubresourceRange *p_ranges) override;
250 void clear_depth_stencil_image(VkImage image,
251 VkImageLayout image_layout,
252 const VkClearDepthStencilValue *p_depth_stencil,
253 uint32_t range_count,
254 const VkImageSubresourceRange *p_ranges) override;
255 void clear_attachments(uint32_t attachment_count,
256 const VkClearAttachment *p_attachments,
257 uint32_t rect_count,
258 const VkClearRect *p_rects) override;
259 void pipeline_barrier(VkPipelineStageFlags src_stage_mask,
260 VkPipelineStageFlags dst_stage_mask,
261 VkDependencyFlags dependency_flags,
262 uint32_t memory_barrier_count,
263 const VkMemoryBarrier *p_memory_barriers,
264 uint32_t buffer_memory_barrier_count,
265 const VkBufferMemoryBarrier *p_buffer_memory_barriers,
266 uint32_t image_memory_barrier_count,
267 const VkImageMemoryBarrier *p_image_memory_barriers) override;
268 void push_constants(VkPipelineLayout layout,
269 VkShaderStageFlags stage_flags,
270 uint32_t offset,
271 uint32_t size,
272 const void *p_values) override;
273 void set_viewport(const Vector<VkViewport> viewports) override;
274 void set_scissor(const Vector<VkRect2D> scissors) override;
275 void set_line_width(const float line_width) override;
276 void set_front_face(const VkFrontFace front_face) override;
277 void set_vertex_input(
278 Span<VkVertexInputBindingDescription2EXT> vertex_binding_descriptions,
279 Span<VkVertexInputAttributeDescription2EXT> vertex_attribute_descriptions) override;
280
281 void set_stencil_compare_mask(const uint32_t compare_mask) override;
282 void set_stencil_write_mask(const uint32_t write_mask) override;
283 void set_stencil_reference(const uint32_t reference) override;
284 void begin_query(VkQueryPool vk_query_pool,
285 uint32_t query_index,
286 VkQueryControlFlags vk_query_control_flags) override;
287 void end_query(VkQueryPool vk_query_pool, uint32_t query_index) override;
288 void reset_query_pool(VkQueryPool, uint32_t first_query, uint32_t query_count) override;
289 void begin_rendering(const VkRenderingInfo *p_rendering_info) override;
290 void end_rendering() override;
291 void begin_debug_utils_label(const VkDebugUtilsLabelEXT *vk_debug_utils_label) override;
292 void end_debug_utils_label() override;
293
294 /* VK_KHR_ray_tracing */
296 const VkAccelerationStructureBuildGeometryInfoKHR *p_infos,
297 const VkAccelerationStructureBuildRangeInfoKHR *p_build_range_infos) override;
298};
299} // namespace gpu::render_graph
300
301} // namespace blender
virtual void set_scissor(const Vector< VkRect2D > scissors)=0
virtual void fill_buffer(VkBuffer dst_buffer, VkDeviceSize dst_offset, VkDeviceSize size, uint32_t data)=0
virtual void bind_pipeline(VkPipelineBindPoint pipeline_bind_point, VkPipeline pipeline)=0
virtual void set_vertex_input(Span< VkVertexInputBindingDescription2EXT > vertex_binding_descriptions, Span< VkVertexInputAttributeDescription2EXT > vertex_attribute_descriptions)=0
virtual void draw_indexed(uint32_t index_count, uint32_t instance_count, uint32_t first_index, int32_t vertex_offset, uint32_t first_instance)=0
virtual void set_stencil_reference(const uint32_t reference)=0
virtual void bind_vertex_buffers(uint32_t first_binding, uint32_t binding_count, const VkBuffer *p_buffers, const VkDeviceSize *p_offsets)=0
virtual void clear_color_image(VkImage image, VkImageLayout image_layout, const VkClearColorValue *p_color, uint32_t range_count, const VkImageSubresourceRange *p_ranges)=0
virtual void copy_buffer(VkBuffer src_buffer, VkBuffer dst_buffer, uint32_t region_count, const VkBufferCopy *p_regions)=0
virtual void bind_descriptor_sets(VkPipelineBindPoint pipeline_bind_point, VkPipelineLayout layout, uint32_t first_set, uint32_t descriptor_set_count, const VkDescriptorSet *p_descriptor_sets, uint32_t dynamic_offset_count, const uint32_t *p_dynamic_offsets)=0
virtual void begin_query(VkQueryPool vk_query_pool, uint32_t query_index, VkQueryControlFlags vk_query_control_flags)=0
virtual void set_stencil_compare_mask(const uint32_t compare_mask)=0
virtual void end_query(VkQueryPool vk_query_pool, uint32_t query_index)=0
virtual void clear_attachments(uint32_t attachment_count, const VkClearAttachment *p_attachments, uint32_t rect_count, const VkClearRect *p_rects)=0
virtual void clear_depth_stencil_image(VkImage image, VkImageLayout image_layout, const VkClearDepthStencilValue *p_depth_stencil, uint32_t range_count, const VkImageSubresourceRange *p_ranges)=0
virtual void draw(uint32_t vertex_count, uint32_t instance_count, uint32_t first_vertex, uint32_t first_instance)=0
virtual void copy_image(VkImage src_image, VkImageLayout src_image_layout, VkImage dst_image, VkImageLayout dst_image_layout, uint32_t region_count, const VkImageCopy *p_regions)=0
virtual void set_stencil_write_mask(const uint32_t write_mask)=0
virtual void blit_image(VkImage src_image, VkImageLayout src_image_layout, VkImage dst_image, VkImageLayout dst_image_layout, uint32_t region_count, const VkImageBlit *p_regions, VkFilter filter)=0
virtual void copy_buffer_to_image(VkBuffer src_buffer, VkImage dst_image, VkImageLayout dst_image_layout, uint32_t region_count, const VkBufferImageCopy *p_regions)=0
virtual void begin_debug_utils_label(const VkDebugUtilsLabelEXT *vk_debug_utils_label)=0
virtual void copy_image_to_buffer(VkImage src_image, VkImageLayout src_image_layout, VkBuffer dst_buffer, uint32_t region_count, const VkBufferImageCopy *p_regions)=0
virtual void reset_query_pool(VkQueryPool vk_query_pool, uint32_t first_query, uint32_t query_count)=0
virtual void set_viewport(const Vector< VkViewport > viewports)=0
virtual void set_line_width(const float line_width)=0
virtual void bind_index_buffer(VkBuffer buffer, VkDeviceSize offset, VkIndexType index_type)=0
virtual void push_constants(VkPipelineLayout layout, VkShaderStageFlags stage_flags, uint32_t offset, uint32_t size, const void *p_values)=0
virtual void begin_rendering(const VkRenderingInfo *p_rendering_info)=0
virtual void dispatch_indirect(VkBuffer buffer, VkDeviceSize offset)=0
virtual void update_buffer(VkBuffer dst_buffer, VkDeviceSize dst_offset, VkDeviceSize data_size, const void *p_data)=0
virtual void build_acceleration_structure(const VkAccelerationStructureBuildGeometryInfoKHR *p_infos, const VkAccelerationStructureBuildRangeInfoKHR *p_build_range_infos)=0
virtual void pipeline_barrier(VkPipelineStageFlags src_stage_mask, VkPipelineStageFlags dst_stage_mask, VkDependencyFlags dependency_flags, uint32_t memory_barrier_count, const VkMemoryBarrier *p_memory_barriers, uint32_t buffer_memory_barrier_count, const VkBufferMemoryBarrier *p_buffer_memory_barriers, uint32_t image_memory_barrier_count, const VkImageMemoryBarrier *p_image_memory_barriers)=0
virtual void draw_indexed_indirect(VkBuffer buffer, VkDeviceSize offset, uint32_t draw_count, uint32_t stride)=0
virtual void draw_indirect(VkBuffer buffer, VkDeviceSize offset, uint32_t draw_count, uint32_t stride)=0
virtual void set_front_face(const VkFrontFace front_face)=0
virtual void dispatch(uint32_t group_count_x, uint32_t group_count_y, uint32_t group_count_z)=0
void begin_debug_utils_label(const VkDebugUtilsLabelEXT *vk_debug_utils_label) override
void bind_descriptor_sets(VkPipelineBindPoint pipeline_bind_point, VkPipelineLayout layout, uint32_t first_set, uint32_t descriptor_set_count, const VkDescriptorSet *p_descriptor_sets, uint32_t dynamic_offset_count, const uint32_t *p_dynamic_offsets) override
void clear_attachments(uint32_t attachment_count, const VkClearAttachment *p_attachments, uint32_t rect_count, const VkClearRect *p_rects) override
void clear_depth_stencil_image(VkImage image, VkImageLayout image_layout, const VkClearDepthStencilValue *p_depth_stencil, uint32_t range_count, const VkImageSubresourceRange *p_ranges) override
void draw_indexed(uint32_t index_count, uint32_t instance_count, uint32_t first_index, int32_t vertex_offset, uint32_t first_instance) override
void fill_buffer(VkBuffer dst_buffer, VkDeviceSize dst_offset, VkDeviceSize size, uint32_t data) override
void copy_image_to_buffer(VkImage src_image, VkImageLayout src_image_layout, VkBuffer dst_buffer, uint32_t region_count, const VkBufferImageCopy *p_regions) override
void bind_pipeline(VkPipelineBindPoint pipeline_bind_point, VkPipeline pipeline) override
void begin_query(VkQueryPool vk_query_pool, uint32_t query_index, VkQueryControlFlags vk_query_control_flags) override
void draw_indirect(VkBuffer buffer, VkDeviceSize offset, uint32_t draw_count, uint32_t stride) override
void dispatch_indirect(VkBuffer buffer, VkDeviceSize offset) override
void set_stencil_compare_mask(const uint32_t compare_mask) override
void pipeline_barrier(VkPipelineStageFlags src_stage_mask, VkPipelineStageFlags dst_stage_mask, VkDependencyFlags dependency_flags, uint32_t memory_barrier_count, const VkMemoryBarrier *p_memory_barriers, uint32_t buffer_memory_barrier_count, const VkBufferMemoryBarrier *p_buffer_memory_barriers, uint32_t image_memory_barrier_count, const VkImageMemoryBarrier *p_image_memory_barriers) override
void clear_color_image(VkImage image, VkImageLayout image_layout, const VkClearColorValue *p_color, uint32_t range_count, const VkImageSubresourceRange *p_ranges) override
void copy_buffer_to_image(VkBuffer src_buffer, VkImage dst_image, VkImageLayout dst_image_layout, uint32_t region_count, const VkBufferImageCopy *p_regions) override
void draw_indexed_indirect(VkBuffer buffer, VkDeviceSize offset, uint32_t draw_count, uint32_t stride) override
void begin_rendering(const VkRenderingInfo *p_rendering_info) override
void set_stencil_write_mask(const uint32_t write_mask) override
void copy_image(VkImage src_image, VkImageLayout src_image_layout, VkImage dst_image, VkImageLayout dst_image_layout, uint32_t region_count, const VkImageCopy *p_regions) override
void update_buffer(VkBuffer dst_buffer, VkDeviceSize dst_offset, VkDeviceSize data_size, const void *p_data) override
void set_front_face(const VkFrontFace front_face) override
void push_constants(VkPipelineLayout layout, VkShaderStageFlags stage_flags, uint32_t offset, uint32_t size, const void *p_values) override
void end_query(VkQueryPool vk_query_pool, uint32_t query_index) override
VKCommandBufferWrapper(VkCommandBuffer vk_command_buffer, const VolkDeviceTable &functions, const VKExtensions &extensions, const VKWorkarounds &workarounds)
void build_acceleration_structure(const VkAccelerationStructureBuildGeometryInfoKHR *p_infos, const VkAccelerationStructureBuildRangeInfoKHR *p_build_range_infos) override
void set_stencil_reference(const uint32_t reference) override
void copy_buffer(VkBuffer src_buffer, VkBuffer dst_buffer, uint32_t region_count, const VkBufferCopy *p_regions) override
void reset_query_pool(VkQueryPool, uint32_t first_query, uint32_t query_count) override
void set_scissor(const Vector< VkRect2D > scissors) override
void blit_image(VkImage src_image, VkImageLayout src_image_layout, VkImage dst_image, VkImageLayout dst_image_layout, uint32_t region_count, const VkImageBlit *p_regions, VkFilter filter) override
void dispatch(uint32_t group_count_x, uint32_t group_count_y, uint32_t group_count_z) override
void set_viewport(const Vector< VkViewport > viewports) override
void bind_index_buffer(VkBuffer buffer, VkDeviceSize offset, VkIndexType index_type) override
void set_vertex_input(Span< VkVertexInputBindingDescription2EXT > vertex_binding_descriptions, Span< VkVertexInputAttributeDescription2EXT > vertex_attribute_descriptions) override
void bind_vertex_buffers(uint32_t first_binding, uint32_t binding_count, const VkBuffer *p_buffers, const VkDeviceSize *p_offsets) override
BMesh Iterators.
unsigned int uint32_t
Definition BKE_text.h:81
BMesh const char void * data
signed int int32_t
Definition BKE_text.h:78