Blender V5.3
blender::gpu::render_graph::VKResourceStateTracker Class Reference

#include <vk_resource_state_tracker.hh>

Classes

struct  DiscardableResource

Public Member Functions

template<typename VkView>
void register_view (ResourceHandle resource_handle, VkView vk_view)
Adding resources
ResourceHandle add_buffer (VkBuffer vk_buffer, VmaAllocation allocation=VK_NULL_HANDLE, const char *name=nullptr)
ResourceHandle add_image (VkImage vk_image, bool use_subresource_tracking, VmaAllocation allocation=VK_NULL_HANDLE, const char *name=nullptr)
ResourceHandle add_aliased_image (VkImage vk_image, bool use_subresource_tracking, VmaAllocation allocation=VK_NULL_HANDLE, const char *name=nullptr)
 Register an image resource that can have aliased memory.
ResourceHandle add_swapchain_image (VkImage vk_image, const char *name=nullptr)

Public Attributes

Mutex mutex

Friends

class VKCommandBuilder
struct VKRenderGraphLink
class VKScheduler
class VKRenderGraph

vk_image_layout: The layout the resource state tracker should now be using, matching the

current layout of the image.

bool use_dynamic_rendering_local_read = true
void update_image_layout (ResourceHandle image_handle, VkImageLayout vk_image_layout)
void deref_resource (ResourceHandle resource_handle)
Vector< DiscardableResource > pop_discardable_resources ()
void remove_image (ResourceHandle image_handle)
VkBuffer remove_buffer (ResourceHandle buffer_handle)
const VkImage get_vk_image (ResourceHandle image_handle)
void remove_swapchain_image (ResourceHandle image_handle)
Vector< std::variant< VkImageView, VkBufferView > > take_views (ResourceHandle resource_handle)
ResourceWithStamp get_image_and_increase_stamp (VkImage vk_image)
ResourceWithStamp get_buffer_and_increase_stamp (ResourceHandle buffer_handle)
ResourceWithStamp get_buffer (ResourceHandle buffer_handle) const
ResourceWithStamp get_image (VkImage vk_image) const
void debug_print () const

Detailed Description

Class to track resources.

Resources are tracked on device level. Their are two kind of resources, namely buffers and images. Each resource can have multiple versions; every time a resource is changed (written to) a new version is tracked.

Definition at line 92 of file vk_resource_state_tracker.hh.

Member Function Documentation

◆ add_aliased_image()

ResourceHandle blender::gpu::render_graph::VKResourceStateTracker::add_aliased_image ( VkImage vk_image,
bool use_subresource_tracking,
VmaAllocation allocation = VK_NULL_HANDLE,
const char * name = nullptr )

Register an image resource that can have aliased memory.

The aliased memory can still be in use and requires the image to wait for all commands to be completed, before it can start writing to the aliased memory.

Definition at line 78 of file vk_resource_state_tracker.cc.

References add_image().

Referenced by blender::gpu::create_and_bind_vk_image().

◆ add_buffer()

ResourceHandle blender::gpu::render_graph::VKResourceStateTracker::add_buffer ( VkBuffer vk_buffer,
VmaAllocation allocation = VK_NULL_HANDLE,
const char * name = nullptr )

Register a buffer resource.

When a buffer is created in VKBuffer, it needs to be registered in the device resources so the resource state can be tracked during its lifetime.

Definition at line 104 of file vk_resource_state_tracker.cc.

References blender::gpu::render_graph::BUFFER, lock, mutex, and UNUSED_VARS_NDEBUG.

Referenced by blender::gpu::VKBuffer::create().

◆ add_image()

ResourceHandle blender::gpu::render_graph::VKResourceStateTracker::add_image ( VkImage vk_image,
bool use_subresource_tracking,
VmaAllocation allocation = VK_NULL_HANDLE,
const char * name = nullptr )

Register an image resource.

When an image is created in VKTexture, it needs to be registered in the device resources so the resource state can be tracked during its lifetime.

Definition at line 70 of file vk_resource_state_tracker.cc.

References add_image().

Referenced by add_aliased_image(), add_image(), and add_swapchain_image().

◆ add_swapchain_image()

ResourceHandle blender::gpu::render_graph::VKResourceStateTracker::add_swapchain_image ( VkImage vk_image,
const char * name = nullptr )

Definition at line 92 of file vk_resource_state_tracker.cc.

References add_image().

◆ debug_print()

void blender::gpu::render_graph::VKResourceStateTracker::debug_print ( ) const

◆ deref_resource()

void blender::gpu::render_graph::VKResourceStateTracker::deref_resource ( ResourceHandle resource_handle)

Release one reference of a resource.

When the ref count reaches zero the resource is marked discardable, to be collected with pop_discardable_resources.

Definition at line 151 of file vk_resource_state_tracker.cc.

References lock, and mutex.

Referenced by blender::gpu::VKImageCache::discard_all_of(), blender::gpu::VKBuffer::free(), blender::gpu::VKTexturePool::release_texture(), blender::gpu::VKImageCache::reset(), and blender::gpu::VKTexture::~VKTexture().

◆ get_buffer()

◆ get_buffer_and_increase_stamp()

ResourceWithStamp blender::gpu::render_graph::VKResourceStateTracker::get_buffer_and_increase_stamp ( ResourceHandle buffer_handle)
inline

Return the current stamp of the resource, and increase the stamp.

When a node writes to a buffer, this method is called to increase the stamp of the buffer. The node that writes to the buffer will use the current stamp as its input, but generate the new stamp for future nodes.

This function is called when adding a node to the render graph, during building resource dependencies. See VKNodeInfo.build_links

Definition at line 331 of file vk_resource_state_tracker.hh.

Referenced by blender::gpu::render_graph::VKBuildAccelerationStructureNode::build_links(), blender::gpu::render_graph::VKCopyBufferNode::build_links(), blender::gpu::render_graph::VKCopyImageToBufferNode::build_links(), blender::gpu::render_graph::VKFillBufferNode::build_links(), blender::gpu::render_graph::VKResourceAccessInfo::build_links(), and blender::gpu::render_graph::VKUpdateBufferNode::build_links().

◆ get_image()

ResourceWithStamp blender::gpu::render_graph::VKResourceStateTracker::get_image ( VkImage vk_image) const
inline

Return the current stamp of the resource.

When a node reads from an image, this method is called to get the current stamp the image.

This function is called when adding a node to the render graph, during building resource dependencies. See VKNodeInfo.build_links

Definition at line 357 of file vk_resource_state_tracker.hh.

Referenced by blender::gpu::render_graph::VKBlitImageNode::build_links(), blender::gpu::render_graph::VKCopyImageNode::build_links(), blender::gpu::render_graph::VKCopyImageToBufferNode::build_links(), and blender::gpu::render_graph::VKResourceAccessInfo::build_links().

◆ get_image_and_increase_stamp()

ResourceWithStamp blender::gpu::render_graph::VKResourceStateTracker::get_image_and_increase_stamp ( VkImage vk_image)
inline

Return the current stamp of the resource, and increase the stamp.

When a node writes to an image, this method is called to increase the stamp of the image. The node that writes to the image will use the current stamp as its input, but generate a new stamp for future nodes.

This function is called when adding a node to the render graph, during building resource dependencies. See VKNodeInfo.build_links

Definition at line 315 of file vk_resource_state_tracker.hh.

Referenced by blender::gpu::render_graph::VKBlitImageNode::build_links(), blender::gpu::render_graph::VKClearColorImageNode::build_links(), blender::gpu::render_graph::VKClearDepthStencilImageNode::build_links(), blender::gpu::render_graph::VKCopyBufferToImageNode::build_links(), blender::gpu::render_graph::VKCopyImageNode::build_links(), blender::gpu::render_graph::VKResourceAccessInfo::build_links(), blender::gpu::render_graph::VKSynchronizationNode::build_links(), and blender::gpu::render_graph::VKUpdateMipmapsNode::build_links().

◆ get_vk_image()

const VkImage blender::gpu::render_graph::VKResourceStateTracker::get_vk_image ( ResourceHandle image_handle)
inline

Definition at line 284 of file vk_resource_state_tracker.hh.

References lock, and mutex.

Referenced by blender::gpu::VKDiscardPool::destroy_discarded_resources().

◆ pop_discardable_resources()

Vector< VKResourceStateTracker::DiscardableResource > blender::gpu::render_graph::VKResourceStateTracker::pop_discardable_resources ( )

◆ register_view()

template<typename VkView>
void blender::gpu::render_graph::VKResourceStateTracker::register_view ( ResourceHandle resource_handle,
VkView vk_view )
inline

Register an image or buffer view on a resource; the view is destroyed together with it.

Definition at line 223 of file vk_resource_state_tracker.hh.

References lock, and mutex.

Referenced by blender::gpu::VKVertexBuffer::ensure_buffer_view(), and blender::gpu::VKImageView::VKImageView().

◆ remove_buffer()

VkBuffer blender::gpu::render_graph::VKResourceStateTracker::remove_buffer ( ResourceHandle buffer_handle)

Unregister a buffer that has been destroyed externally (e.g. via vmaDestroyBuffer).

Definition at line 184 of file vk_resource_state_tracker.cc.

References blender::BLI_assert(), lock, mutex, and blender::gpu::render_graph::NONE.

Referenced by blender::gpu::VKDiscardPool::destroy_discarded_resources().

◆ remove_image()

void blender::gpu::render_graph::VKResourceStateTracker::remove_image ( ResourceHandle image_handle)

Unregister an image that has been destroyed externally (e.g. via vmaDestroyImage).

Definition at line 203 of file vk_resource_state_tracker.cc.

References blender::BLI_assert(), lock, mutex, and blender::gpu::render_graph::NONE.

Referenced by blender::gpu::VKDiscardPool::destroy_discarded_resources().

◆ remove_swapchain_image()

void blender::gpu::render_graph::VKResourceStateTracker::remove_swapchain_image ( ResourceHandle image_handle)

Unregister a swapchain image that has been destroyed externally.

Definition at line 220 of file vk_resource_state_tracker.cc.

References blender::BLI_assert(), lock, mutex, and blender::gpu::render_graph::NONE.

Referenced by blender::gpu::VKDiscardPool::destroy_discarded_resources().

◆ take_views()

Vector< std::variant< VkImageView, VkBufferView > > blender::gpu::render_graph::VKResourceStateTracker::take_views ( ResourceHandle resource_handle)
inline

Take ownership of the views registered on a resource; the caller must destroy them. Only valid while the resource is still registered.

Definition at line 299 of file vk_resource_state_tracker.hh.

References lock, and mutex.

Referenced by blender::gpu::VKDiscardPool::destroy_discarded_resources().

◆ update_image_layout()

void blender::gpu::render_graph::VKResourceStateTracker::update_image_layout ( ResourceHandle image_handle,
VkImageLayout vk_image_layout )

◆ VKCommandBuilder

friend class VKCommandBuilder
friend

Definition at line 95 of file vk_resource_state_tracker.hh.

References VKCommandBuilder.

Referenced by VKCommandBuilder.

◆ VKRenderGraph

friend class VKRenderGraph
friend

Definition at line 98 of file vk_resource_state_tracker.hh.

References VKRenderGraph.

Referenced by VKRenderGraph.

◆ VKRenderGraphLink

friend struct VKRenderGraphLink
friend

Definition at line 96 of file vk_resource_state_tracker.hh.

References VKRenderGraphLink.

Referenced by VKRenderGraphLink.

◆ VKScheduler

friend class VKScheduler
friend

Definition at line 97 of file vk_resource_state_tracker.hh.

References VKScheduler.

Referenced by VKScheduler.

Member Data Documentation

◆ mutex

Mutex blender::gpu::render_graph::VKResourceStateTracker::mutex

Device resource mutex

The mutex is stored in resources due to:

  • It protects resources and their state.
  • Allowing test cases to do testing without setting up a device instance which requires ghost.
  • Device instance isn't accessible in test cases.

Definition at line 185 of file vk_resource_state_tracker.hh.

Referenced by add_buffer(), blender::gpu::VKDevice::current_thread_data(), deref_resource(), get_vk_image(), pop_discardable_resources(), register_view(), remove_buffer(), remove_image(), remove_swapchain_image(), blender::gpu::VKDevice::render_graph_new(), blender::gpu::VKDevice::submission_runner(), take_views(), and update_image_layout().

◆ use_dynamic_rendering_local_read


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