Blender V5.3
blender::gpu::VKDiscardPool Class Reference

#include <vk_resource_pool.hh>

Public Member Functions

void deinit (VKDevice &device)
void discard_swapchain_image (ResourceHandle image_handle)
void discard_image_view (VkImageView vk_image_view)
void discard_resources (Span< render_graph::VKResourceStateTracker::DiscardableResource > discardable, TimelineValue timeline)
void discard_allocation (VmaAllocation vma_allocation)
void discard_shader_module (VkShaderModule vk_shader_module)
void discard_pipeline (VkPipeline vk_pipeline)
void discard_pipeline_layout (VkPipelineLayout vk_pipeline_layout)
void discard_descriptor_pool_for_reuse (VkDescriptorPool vk_descriptor_pool, VKDescriptorPools *descriptor_pools)
void discard_acceleration_structure (VkAccelerationStructureKHR vk_acceleration_structure)
void move_data (VKDiscardPool &src_pool, TimelineValue timeline)
Mutex & mutex_get ()
void destroy_discarded_resources (VKDevice &device, TimelineValue current_timeline)

Static Public Member Functions

static VKDiscardPool & discard_pool_get ()

Friends

class VKDevice
class VKBackend
std::ostream & operator<< (std::ostream &os, const VKDiscardPool &discard_pool)

Detailed Description

Pool of resources that are discarded, but can still be in used and cannot be destroyed.

When GPU resources are deleted (GPU_*_delete) the GPU handles are kept inside a discard pool. When we are sure that the resource isn't used on the GPU anymore we can safely destroy it.

When preparing the next frame, the previous frame can still be rendered. Resources that needs to be destroyed can only be when the previous frame has been completed and being displayed on the screen.

Definition at line 79 of file vk_resource_pool.hh.

Member Function Documentation

◆ deinit()

void blender::gpu::VKDiscardPool::deinit ( VKDevice & device)

Definition at line 15 of file vk_resource_pool.cc.

References destroy_discarded_resources(), UINT64_MAX, and VKDevice.

Referenced by blender::gpu::VKDevice::deinit(), and VKBackend.

◆ destroy_discarded_resources()

◆ discard_acceleration_structure()

void blender::gpu::VKDiscardPool::discard_acceleration_structure ( VkAccelerationStructureKHR vk_acceleration_structure)

◆ discard_allocation()

void blender::gpu::VKDiscardPool::discard_allocation ( VmaAllocation vma_allocation)

Definition at line 99 of file vk_resource_pool.cc.

Referenced by VKBackend.

◆ discard_descriptor_pool_for_reuse()

void blender::gpu::VKDiscardPool::discard_descriptor_pool_for_reuse ( VkDescriptorPool vk_descriptor_pool,
VKDescriptorPools * descriptor_pools )

Definition at line 121 of file vk_resource_pool.cc.

Referenced by VKBackend.

◆ discard_image_view()

void blender::gpu::VKDiscardPool::discard_image_view ( VkImageView vk_image_view)

Discard an image view that belongs to a resource removed outside the discard flow (e.g. a swapchain image).

Definition at line 53 of file vk_resource_pool.cc.

Referenced by VKBackend.

◆ discard_pipeline()

void blender::gpu::VKDiscardPool::discard_pipeline ( VkPipeline vk_pipeline)

◆ discard_pipeline_layout()

void blender::gpu::VKDiscardPool::discard_pipeline_layout ( VkPipelineLayout vk_pipeline_layout)

Definition at line 115 of file vk_resource_pool.cc.

Referenced by VKBackend, and blender::gpu::VKShader::~VKShader().

◆ discard_pool_get()

VKDiscardPool & blender::gpu::VKDiscardPool::discard_pool_get ( )
static

◆ discard_resources()

void blender::gpu::VKDiscardPool::discard_resources ( Span< render_graph::VKResourceStateTracker::DiscardableResource > discardable,
TimelineValue timeline )

Discard a batch of resources (and their registered views).

Scheduling a resource that is already scheduled for destruction is an error (asserted).

Definition at line 58 of file vk_resource_pool.cc.

References blender::BLI_assert(), blender::gpu::render_graph::BUFFER, and blender::gpu::render_graph::IMAGE.

Referenced by blender::gpu::VKDevice::deinit(), blender::gpu::VKDevice::submission_runner(), and VKBackend.

◆ discard_shader_module()

void blender::gpu::VKDiscardPool::discard_shader_module ( VkShaderModule vk_shader_module)

Definition at line 105 of file vk_resource_pool.cc.

Referenced by VKBackend, and blender::gpu::VKShaderModule::~VKShaderModule().

◆ discard_swapchain_image()

void blender::gpu::VKDiscardPool::discard_swapchain_image ( ResourceHandle image_handle)

Definition at line 47 of file vk_resource_pool.cc.

Referenced by VKBackend.

◆ move_data()

void blender::gpu::VKDiscardPool::move_data ( VKDiscardPool & src_pool,
TimelineValue timeline )

Move discarded resources from src_pool into this.

GPU resources that are discarded from the dependency graph are stored in the device orphaned data. When a swap-chain context list is made active the orphaned data can be merged into a swap-chain discard pool.

All moved items will receive a new timeline.

Function must be externally synced:

{
std::scoped_lock lock(pool.mutex_get()));
pool.move_data(src_pool, timeline);
}
volatile int lock

Definition at line 20 of file vk_resource_pool.cc.

References blender::gpu::TimelineResources< Item >::update_timeline().

Referenced by blender::gpu::VKDevice::context_unregister(), blender::gpu::VKDevice::render_graph_submit(), and VKBackend.

◆ mutex_get()

Mutex & blender::gpu::VKDiscardPool::mutex_get ( )
inline

◆ operator<<

std::ostream & operator<< ( std::ostream & os,
const VKDiscardPool & discard_pool )
friend

◆ VKBackend

◆ VKDevice

friend class VKDevice
friend

Definition at line 80 of file vk_resource_pool.hh.

References VKDevice.

Referenced by deinit(), destroy_discarded_resources(), discard_pool_get(), VKBackend, and VKDevice.


The documentation for this class was generated from the following files: