Blender V5.3
vk_command_builder.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 "BLI_set.hh"
12
13#include "vk_common.hh"
15#include "vk_scheduler.hh"
16
18class VKRenderGraph;
19
26
34 private:
39 Vector<VkBufferMemoryBarrier> vk_buffer_memory_barriers_;
44 Vector<VkImageMemoryBarrier> vk_image_memory_barriers_;
45
46 struct Barrier {
48 IndexRange buffer_memory_barriers;
50 IndexRange image_memory_barriers;
51
52 VkPipelineStageFlags src_stage_mask = VK_PIPELINE_STAGE_NONE;
53 VkPipelineStageFlags dst_stage_mask = VK_PIPELINE_STAGE_NONE;
54
55 bool is_empty() const
56 {
57 return buffer_memory_barriers.is_empty() && image_memory_barriers.is_empty();
58 }
59 };
60
66 struct ImageTracker {
72 VKCommandBuilder &command_builder;
73 ImageTracker(VKCommandBuilder &command_builder) : command_builder(command_builder) {}
74
82 Set<VkImage> tracked_attachments;
83
89 VkImage vk_image;
90 VkImageLayout vk_image_layout;
91 VkImageAspectFlags vk_image_aspect;
93 };
95
102 void begin(const VKRenderGraph &render_graph, NodeHandle node_handle);
103
107 inline bool contains(VkImage vk_image) const
108 {
109 return tracked_attachments.contains(vk_image);
110 }
111
117 void update(VkImage vk_image,
118 const VKSubImageRange &subimage,
119 VkImageLayout old_layout,
120 VkImageLayout new_layout,
121 VkImageAspectFlags aspect,
122 Barrier &r_barrier);
128 void update(VkImage vk_image,
129 uint32_t mipmap_level,
130 VkImageLayout old_layout,
131 VkImageLayout new_layout,
132 VkImageAspectFlags aspect,
133 Barrier &r_barrier);
134
143 void end(Barrier &r_barrier, bool use_local_read);
144
153 void suspend(Barrier &r_barrier, bool use_local_read);
154
161 void resume(Barrier &r_barrier, bool use_local_read);
162 };
163
170 using GroupNodes = IndexRange;
171
175 using Barriers = IndexRange;
176 using BarrierIndex = int64_t;
177
179 Vector<GroupNodes> group_nodes_;
181 Vector<Barriers> group_pre_barriers_;
183 Vector<Barriers> group_post_barriers_;
188 Vector<Barriers> node_pre_barriers_;
189
191 Vector<Barrier> barrier_list_;
192
193 public:
199 VKCommandBufferInterface &command_buffer,
200 Span<NodeHandle> node_handles);
201
209 VKCommandBufferInterface &command_buffer,
210 Span<NodeHandle> node_handles);
211
212 private:
219 void groups_init(const VKRenderGraph &render_graph, Span<NodeHandle> node_handles);
220
228 void groups_extract_barriers(VKRenderGraph &render_graph,
229 Span<NodeHandle> node_handles,
230 bool use_local_read);
231
235 void groups_build_commands(VKRenderGraph &render_graph,
236 VKCommandBufferInterface &command_buffer,
237 Span<NodeHandle> node_handles);
238
243 void build_pipeline_barriers(VKRenderGraph &render_graph,
244 NodeHandle node_handle,
245 VkPipelineStageFlags pipeline_stage,
246 ImageTracker &image_tracker,
247 Barrier &r_barrier,
248 bool within_rendering = false);
249 void reset_barriers(Barrier &r_barrier);
250 void send_pipeline_barriers(VKCommandBufferInterface &command_buffer,
251 const Barrier &barrier,
252 bool within_rendering);
253
254 void add_buffer_barriers(VKRenderGraph &render_graph,
255 NodeHandle node_handle,
256 VkPipelineStageFlags node_stages,
257 Barrier &r_barrier);
258 void add_buffer_barrier(VkBuffer vk_buffer,
259 Barrier &r_barrier,
260 VkAccessFlags src_access_mask,
261 VkAccessFlags dst_access_mask);
262 void add_buffer_read_barriers(VKRenderGraph &render_graph,
263 NodeHandle node_handle,
264 VkPipelineStageFlags node_stages,
265 Barrier &r_barrier);
266 void add_buffer_write_barriers(VKRenderGraph &render_graph,
267 NodeHandle node_handle,
268 VkPipelineStageFlags node_stages,
269 Barrier &r_barrier);
270
271 void add_image_barriers(VKRenderGraph &render_graph,
272 NodeHandle node_handle,
273 VkPipelineStageFlags node_stages,
274 ImageTracker &image_tracker,
275 Barrier &r_barrier,
276 bool within_rendering);
277 void add_image_barrier(VkImage vk_image,
278 Barrier &r_barrier,
279 VkAccessFlags src_access_mask,
280 VkAccessFlags dst_access_mask,
281 VkImageLayout old_image_layout,
282 VkImageLayout new_image_layout,
283 VkImageAspectFlags aspect_mask,
284 const VKSubImageRange &subimage);
285 void add_image_read_barriers(VKRenderGraph &render_graph,
286 NodeHandle node_handle,
287 VkPipelineStageFlags node_stages,
288 ImageTracker &image_tracker,
289 Barrier &r_barrier,
290 bool within_rendering);
291 void add_image_write_barriers(VKRenderGraph &render_graph,
292 NodeHandle node_handle,
293 VkPipelineStageFlags node_stages,
294 ImageTracker &image_tracker,
295 Barrier &r_barrier,
296 bool within_rendering);
297
298 struct DebugGroups {
303 int64_t active_debug_group_id = -1;
305 int debug_level = 0;
306 };
307
316 void activate_debug_group(VKRenderGraph &render_graph,
317 VKCommandBufferInterface &command_buffer,
318 DebugGroups &debug_groups,
319 NodeHandle node_handle);
320
324 void finish_debug_groups(VKCommandBufferInterface &command_buffer, DebugGroups &debug_groups);
325
326 private:
330 void layer_tracking_begin(const VKRenderGraph &render_graph, NodeHandle node_handle);
331
337 void layer_tracking_update(VkImage vk_image,
339 uint32_t layer_count,
340 VkImageLayout old_layout,
341 VkImageLayout new_layout);
342
351 void layer_tracking_end(VKCommandBufferInterface &command_buffer);
352
361 void layer_tracking_suspend(VKCommandBufferInterface &command_buffer);
362
369 void layer_tracking_resume(VKCommandBufferInterface &command_buffer);
370
371 bool node_has_input_attachments(const VKRenderGraph &render_graph, NodeHandle node);
372
373 std::string to_string_barrier(const Barrier &barrier);
374};
375
376} // namespace blender::gpu::render_graph
constexpr bool is_empty() const
void record_commands(VKRenderGraph &render_graph, VKCommandBufferInterface &command_buffer, Span< NodeHandle > node_handles)
void build_nodes(VKRenderGraph &render_graph, VKCommandBufferInterface &command_buffer, Span< NodeHandle > node_handles)
#define layer
void barrier()
__int64 int64_t
Definition BKE_text.h:90
unsigned int uint32_t
Definition BKE_text.h:81