Blender V5.0
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
blender::gpu::VKContext Class Reference

#include <vk_context.hh>

Inherits blender::gpu::Context, and blender::NonCopyable.

Public Member Functions

const render_graph::VKRenderGraph & render_graph () const
render_graph::VKRenderGraph & render_graph ()
 VKContext (void *ghost_window, void *ghost_context)
virtual ~VKContext ()
void activate () override
void deactivate () override
void begin_frame () override
void end_frame () override
void flush () override
TimelineValue flush_render_graph (RenderGraphFlushFlags flags, VkPipelineStageFlags wait_dst_stage_mask=VK_PIPELINE_STAGE_NONE, VkSemaphore wait_semaphore=VK_NULL_HANDLE, VkSemaphore signal_semaphore=VK_NULL_HANDLE, VkFence signal_fence=VK_NULL_HANDLE)
void finish () override
void memory_statistics_get (int *r_total_mem_kb, int *r_free_mem_kb) override
void debug_group_begin (const char *, int) override
void debug_group_end () override
bool debug_capture_begin (const char *title) override
void debug_capture_end () override
void * debug_capture_scope_create (const char *name) override
bool debug_capture_scope_begin (void *scope) override
void debug_capture_scope_end (void *scope) override
void sync_backbuffer ()
State manager
void debug_unbind_all_ubo () override
void debug_unbind_all_ssbo () override
VKDescriptorPools & descriptor_pools_get ()
VKDescriptorSetTracker & descriptor_set_get ()
VKStateManager & state_manager_get () const
Frame-buffer
bool has_active_framebuffer () const
void activate_framebuffer (VKFrameBuffer &framebuffer)
void deactivate_framebuffer ()
VKFrameBuffer * active_framebuffer_get () const
void rendering_end ()
Public Member Functions inherited from blender::gpu::Context
 Context ()
virtual ~Context ()
bool is_active_on_thread ()
VertBuf * dummy_vbo_get ()
Batch * procedural_points_batch_get ()
Batch * procedural_lines_batch_get ()
Batch * procedural_triangles_batch_get ()
Batch * procedural_triangle_strips_batch_get ()
void assert_framebuffer_shader_compatibility (Shader *sh)

Static Public Member Functions

static VKContext * get ()
Static Public Member Functions inherited from blender::gpu::Context
static Context * get ()

Public Attributes

VKDiscardPool discard_pool
Public Attributes inherited from blender::gpu::Context
Shader * shader = nullptr
FrameBuffer * active_fb = nullptr
GPUMatrixState * matrix_state = nullptr
StateManager * state_manager = nullptr
Immediate * imm = nullptr
FrameBuffer * back_left = nullptr
FrameBuffer * front_left = nullptr
FrameBuffer * back_right = nullptr
FrameBuffer * front_right = nullptr
DebugStack debug_stack
bool debug_is_capturing = false
int context_id = 0
Vector< StorageBuf * > printf_buf
VertBuf * dummy_vbo = nullptr
Batch * procedural_points_batch = nullptr
Batch * procedural_lines_batch = nullptr
Batch * procedural_triangles_batch = nullptr
Batch * procedural_triangle_strips_batch = nullptr
TexturePool * texture_pool = nullptr
int shader_builtin_srgb_transform = 0
bool shader_builtin_srgb_is_dirty = false

Friends

class VKDevice

Graphics pipeline

void specialization_constants_set (const shader::SpecializationConstants *constants_state)
std::unique_ptr< VKStreamingBuffer > & get_or_create_streaming_buffer (VKBuffer &buffer, VkDeviceSize min_offset_alignment)
static void swap_buffer_draw_callback (const GHOST_VulkanSwapChainData *data)
static void swap_buffer_acquired_callback ()

OpenXR

static void openxr_acquire_framebuffer_image_callback (GHOST_VulkanOpenXRData *data)
static void openxr_release_framebuffer_image_callback (GHOST_VulkanOpenXRData *data)

Pipeline

render_graph::VKResourceAccessInfo & reset_and_get_access_info ()
void update_pipeline_data (render_graph::VKPipelineData &r_pipeline_data)
void update_pipeline_data (GPUPrimType primitive, VKVertexAttributeObject &vao, render_graph::VKPipelineDataGraphics &r_pipeline_data)

Additional Inherited Members

Static Public Attributes inherited from blender::gpu::Context
static int context_counter = 0
Protected Member Functions inherited from blender::gpu::Context
void free_resources ()
Protected Attributes inherited from blender::gpu::Context
pthread_t thread_
bool is_active_
void * ghost_window_

Detailed Description

Definition at line 41 of file vk_context.hh.

Constructor & Destructor Documentation

◆ VKContext()

blender::gpu::VKContext::VKContext ( void * ghost_window,
void * ghost_context )

Definition at line 29 of file vk_context.cc.

References blender::gpu::Context::active_fb, blender::gpu::Context::back_left, blender::gpu::Context::front_left, blender::gpu::Context::ghost_window_, blender::gpu::Context::imm, and blender::gpu::Context::state_manager.

Referenced by get(), openxr_acquire_framebuffer_image_callback(), openxr_release_framebuffer_image_callback(), swap_buffer_acquired_callback(), and swap_buffer_draw_callback().

◆ ~VKContext()

blender::gpu::VKContext::~VKContext ( )
virtual

Definition at line 42 of file vk_context.cc.

References blender::gpu::Context::back_left, blender::gpu::VKDevice::context_unregister(), blender::gpu::VKBackend::device, blender::gpu::Context::free_resources(), blender::gpu::Context::front_left, blender::gpu::VKBackend::get(), GPU_FB_COLOR_ATTACHMENT0, GPU_texture_free(), blender::gpu::Context::imm, and VKDevice.

Member Function Documentation

◆ activate()

void blender::gpu::VKContext::activate ( )
overridevirtual

Implements blender::gpu::Context.

Definition at line 107 of file vk_context.cc.

References BLI_assert, blender::gpu::VKDevice::current_thread_data(), blender::gpu::Context::debug_stack, blender::gpu::VKBackend::device, blender::gpu::VKBackend::get(), blender::gpu::debug::get_debug_group_color(), immActivate(), blender::gpu::Context::is_active_, blender::gpu::VKDevice::render_graph_new(), sync_backbuffer(), and VKDevice.

◆ activate_framebuffer()

void blender::gpu::VKContext::activate_framebuffer ( VKFrameBuffer & framebuffer)

Definition at line 240 of file vk_context.cc.

References blender::gpu::Context::active_fb, BLI_assert, deactivate_framebuffer(), has_active_framebuffer(), blender::gpu::VKFrameBuffer::rendering_reset(), blender::gpu::VKFrameBuffer::update_size(), and blender::gpu::VKFrameBuffer::update_srgb().

◆ active_framebuffer_get()

VKFrameBuffer * blender::gpu::VKContext::active_framebuffer_get ( ) const

Definition at line 253 of file vk_context.cc.

References blender::gpu::Context::active_fb, and blender::gpu::unwrap().

Referenced by deactivate_framebuffer(), flush_render_graph(), has_active_framebuffer(), rendering_end(), and update_pipeline_data().

◆ begin_frame()

void blender::gpu::VKContext::begin_frame ( )
overridevirtual

Implements blender::gpu::Context.

Definition at line 145 of file vk_context.cc.

◆ deactivate()

void blender::gpu::VKContext::deactivate ( )
overridevirtual

Implements blender::gpu::Context.

Definition at line 136 of file vk_context.cc.

References flush_render_graph(), immDeactivate(), and blender::gpu::Context::is_active_.

◆ deactivate_framebuffer()

void blender::gpu::VKContext::deactivate_framebuffer ( )

Definition at line 263 of file vk_context.cc.

References blender::gpu::Context::active_fb, active_framebuffer_get(), BLI_assert, blender::gpu::VKFrameBuffer::is_rendering(), and blender::gpu::VKFrameBuffer::rendering_end().

Referenced by activate_framebuffer(), and sync_backbuffer().

◆ debug_capture_begin()

bool blender::gpu::VKContext::debug_capture_begin ( const char * title)
overridevirtual

Implements blender::gpu::Context.

Definition at line 92 of file vk_debug.cc.

References blender::gpu::VKBackend::debug_capture_begin(), flush_render_graph(), blender::gpu::VKBackend::get(), blender::gpu::RENEW_RENDER_GRAPH, blender::gpu::SUBMIT, and blender::gpu::WAIT_FOR_COMPLETION.

◆ debug_capture_end()

void blender::gpu::VKContext::debug_capture_end ( )
overridevirtual

Implements blender::gpu::Context.

Definition at line 113 of file vk_debug.cc.

References blender::gpu::VKBackend::debug_capture_end(), flush_render_graph(), blender::gpu::VKBackend::get(), blender::gpu::RENEW_RENDER_GRAPH, blender::gpu::SUBMIT, and blender::gpu::WAIT_FOR_COMPLETION.

◆ debug_capture_scope_begin()

bool blender::gpu::VKContext::debug_capture_scope_begin ( void * scope)
overridevirtual

Implements blender::gpu::Context.

Definition at line 132 of file vk_debug.cc.

References blender::gpu::VKBackend::debug_capture_begin(), G, blender::gpu::VKBackend::get(), and UNUSED_VARS.

◆ debug_capture_scope_create()

void * blender::gpu::VKContext::debug_capture_scope_create ( const char * name)
overridevirtual

Implements blender::gpu::Context.

Definition at line 127 of file vk_debug.cc.

References name.

◆ debug_capture_scope_end()

void blender::gpu::VKContext::debug_capture_scope_end ( void * scope)
overridevirtual

Implements blender::gpu::Context.

Definition at line 146 of file vk_debug.cc.

References blender::gpu::VKBackend::debug_capture_end(), G, blender::gpu::VKBackend::get(), and UNUSED_VARS.

◆ debug_group_begin()

void blender::gpu::VKContext::debug_group_begin ( const char * name,
int  )
overridevirtual

Reimplemented from blender::gpu::Context.

Definition at line 24 of file vk_debug.cc.

References blender::gpu::render_graph::VKRenderGraph::debug_group_begin(), G, blender::gpu::debug::get_debug_group_color(), name, and render_graph().

◆ debug_group_end()

void blender::gpu::VKContext::debug_group_end ( )
overridevirtual

Reimplemented from blender::gpu::Context.

Definition at line 40 of file vk_debug.cc.

References CLOG_ERROR, blender::gpu::render_graph::VKRenderGraph::debug_group_end(), G, i, blender::gpu::LOG, and render_graph().

◆ debug_unbind_all_ssbo()

void blender::gpu::VKContext::debug_unbind_all_ssbo ( )
overridevirtual

Implements blender::gpu::Context.

Definition at line 229 of file vk_context.cc.

References state_manager_get(), and blender::gpu::VKStateManager::storage_buffer_unbind_all().

◆ debug_unbind_all_ubo()

void blender::gpu::VKContext::debug_unbind_all_ubo ( )
overridevirtual

Implements blender::gpu::Context.

Definition at line 224 of file vk_context.cc.

References state_manager_get(), and blender::gpu::VKStateManager::uniform_buffer_unbind_all().

◆ descriptor_pools_get()

VKDescriptorPools & blender::gpu::VKContext::descriptor_pools_get ( )

Definition at line 209 of file vk_context.cc.

◆ descriptor_set_get()

VKDescriptorSetTracker & blender::gpu::VKContext::descriptor_set_get ( )

Definition at line 214 of file vk_context.cc.

Referenced by flush_render_graph().

◆ end_frame()

void blender::gpu::VKContext::end_frame ( )
overridevirtual

Implements blender::gpu::Context.

Definition at line 147 of file vk_context.cc.

◆ finish()

void blender::gpu::VKContext::finish ( )
overridevirtual

Implements blender::gpu::Context.

Definition at line 197 of file vk_context.cc.

◆ flush()

void blender::gpu::VKContext::flush ( )
overridevirtual

Implements blender::gpu::Context.

Definition at line 152 of file vk_context.cc.

References flush_render_graph(), and blender::gpu::RENEW_RENDER_GRAPH.

◆ flush_render_graph()

TimelineValue blender::gpu::VKContext::flush_render_graph ( RenderGraphFlushFlags flags,
VkPipelineStageFlags wait_dst_stage_mask = VK_PIPELINE_STAGE_NONE,
VkSemaphore wait_semaphore = VK_NULL_HANDLE,
VkSemaphore signal_semaphore = VK_NULL_HANDLE,
VkFence signal_fence = VK_NULL_HANDLE )

Definition at line 157 of file vk_context.cc.

References active_framebuffer_get(), blender::gpu::Context::debug_stack, descriptor_set_get(), blender::gpu::VKBackend::device, discard_pool, blender::gpu::VKBackend::get(), blender::gpu::debug::get_debug_group_color(), has_active_framebuffer(), blender::gpu::VKFrameBuffer::is_rendering(), blender::gpu::VKDevice::render_graph_new(), blender::gpu::VKDevice::render_graph_submit(), blender::gpu::VKFrameBuffer::rendering_end(), blender::gpu::RENEW_RENDER_GRAPH, blender::gpu::SUBMIT, blender::gpu::VKDescriptorSetTracker::upload_descriptor_sets(), VKDevice, and blender::gpu::WAIT_FOR_COMPLETION.

Referenced by deactivate(), debug_capture_begin(), debug_capture_end(), and flush().

◆ get()

VKContext * blender::gpu::VKContext::get ( )
inlinestatic

Definition at line 145 of file vk_context.hh.

References blender::gpu::Context::get(), and VKContext().

Referenced by blender::gpu::VKDescriptorPools::allocate(), blender::gpu::VKStorageBuffer::async_flush_to_host(), blender::gpu::VKQueryPool::begin_query(), blender::gpu::VKFrameBuffer::bind(), blender::gpu::VKShader::bind(), blender::gpu::VKStorageBuffer::bind(), blender::gpu::VKUniformBuffer::bind(), blender::gpu::VKIndexBuffer::bind_as_ssbo(), blender::gpu::VKUniformBuffer::bind_as_ssbo(), blender::gpu::VKVertexBuffer::bind_as_ssbo(), blender::gpu::VKVertexBuffer::bind_as_texture(), blender::gpu::VKFrameBuffer::blit_to(), blender::gpu::VKFrameBuffer::clear(), blender::gpu::VKStorageBuffer::clear(), blender::gpu::VKTexture::clear(), blender::gpu::VKTexture::clear_depth_stencil(), blender::gpu::VKUniformBuffer::clear_to_zero(), blender::gpu::VKBackend::compute_dispatch(), blender::gpu::VKBackend::compute_dispatch_indirect(), blender::gpu::VKStorageBuffer::copy_sub(), blender::gpu::VKTexture::copy_to(), blender::gpu::VKDiscardPool::discard_pool_get(), blender::gpu::VKBatch::draw(), blender::gpu::VKImmediate::end(), blender::gpu::VKQueryPool::end_query(), blender::gpu::VKIndexBuffer::ensure_updated(), blender::gpu::VKUniformBuffer::ensure_updated(), blender::gpu::VKTexture::generate_mipmap(), blender::gpu::VKQueryPool::get_occlusion_result(), blender::gpu::VKStateManager::issue_barrier(), blender::gpu::VKBatch::multi_draw_indirect(), openxr_acquire_framebuffer_image_callback(), openxr_release_framebuffer_image_callback(), blender::gpu::VKIndexBuffer::read(), blender::gpu::VKStorageBuffer::read(), blender::gpu::VKVertexBuffer::read(), blender::gpu::VKTexture::read_sub(), blender::gpu::VKBackend::render_end(), blender::gpu::VKFence::signal(), blender::gpu::VKFrameBuffer::subpass_transition_impl(), swap_buffer_acquired_callback(), swap_buffer_draw_callback(), blender::gpu::VKStorageBuffer::unbind(), blender::gpu::VKUniformBuffer::unbind(), blender::gpu::VKStorageBuffer::update(), blender::gpu::VKUniformBuffer::update(), blender::gpu::VKTexture::update_sub(), blender::gpu::VKVertexBuffer::update_sub(), blender::gpu::VKVertexBuffer::upload_data(), blender::gpu::VKShader::VKShader(), and blender::gpu::VKFrameBuffer::~VKFrameBuffer().

◆ get_or_create_streaming_buffer()

std::unique_ptr< VKStreamingBuffer > & blender::gpu::VKContext::get_or_create_streaming_buffer ( VKBuffer & buffer,
VkDeviceSize min_offset_alignment )

Definition at line 473 of file vk_context.cc.

References blender::gpu::VKBuffer::vk_handle().

◆ has_active_framebuffer()

bool blender::gpu::VKContext::has_active_framebuffer ( ) const

Definition at line 258 of file vk_context.cc.

References active_framebuffer_get().

Referenced by activate_framebuffer(), flush_render_graph(), and sync_backbuffer().

◆ memory_statistics_get()

void blender::gpu::VKContext::memory_statistics_get ( int * r_total_mem_kb,
int * r_free_mem_kb )
overridevirtual

Implements blender::gpu::Context.

Definition at line 199 of file vk_context.cc.

References blender::gpu::VKBackend::device, blender::gpu::VKBackend::get(), blender::gpu::VKDevice::memory_statistics_get(), and VKDevice.

◆ openxr_acquire_framebuffer_image_callback()

void blender::gpu::VKContext::openxr_acquire_framebuffer_image_callback ( GHOST_VulkanOpenXRData * data)
static

Definition at line 492 of file vk_context.cc.

References BLI_assert, get(), and VKContext().

Referenced by blender::gpu::VKBackend::context_alloc().

◆ openxr_release_framebuffer_image_callback()

void blender::gpu::VKContext::openxr_release_framebuffer_image_callback ( GHOST_VulkanOpenXRData * data)
static

Definition at line 499 of file vk_context.cc.

References BLI_assert, get(), and VKContext().

Referenced by blender::gpu::VKBackend::context_alloc().

◆ render_graph() [1/2]

render_graph::VKRenderGraph & blender::gpu::VKContext::render_graph ( )
inline

Definition at line 83 of file vk_context.hh.

◆ render_graph() [2/2]

const render_graph::VKRenderGraph & blender::gpu::VKContext::render_graph ( ) const
inline

Definition at line 79 of file vk_context.hh.

Referenced by debug_group_begin(), and debug_group_end().

◆ rendering_end()

void blender::gpu::VKContext::rendering_end ( )

Ensure that the active framebuffer isn't rendering.

Between vkCmdBeginRendering and vkCmdEndRendering the framebuffer is rendering. Dispatch and transfer commands cannot be called between these commands. They can call this method to ensure that the framebuffer is outside these calls.

Definition at line 273 of file vk_context.cc.

References active_framebuffer_get(), and blender::gpu::VKFrameBuffer::rendering_end().

◆ reset_and_get_access_info()

render_graph::VKResourceAccessInfo & blender::gpu::VKContext::reset_and_get_access_info ( )

Definition at line 358 of file vk_context.cc.

References blender::gpu::render_graph::VKResourceAccessInfo::reset().

◆ specialization_constants_set()

void blender::gpu::VKContext::specialization_constants_set ( const shader::SpecializationConstants * constants_state)

Definition at line 466 of file vk_context.cc.

Referenced by blender::gpu::VKShader::bind().

◆ state_manager_get()

VKStateManager & blender::gpu::VKContext::state_manager_get ( ) const

Definition at line 219 of file vk_context.cc.

References blender::gpu::Context::state_manager.

Referenced by blender::gpu::VKIndexBuffer::bind_as_ssbo(), debug_unbind_all_ssbo(), debug_unbind_all_ubo(), and update_pipeline_data().

◆ swap_buffer_acquired_callback()

void blender::gpu::VKContext::swap_buffer_acquired_callback ( )
static

Definition at line 370 of file vk_context.cc.

References BLI_assert, get(), and VKContext().

Referenced by blender::gpu::VKBackend::context_alloc().

◆ swap_buffer_draw_callback()

void blender::gpu::VKContext::swap_buffer_draw_callback ( const GHOST_VulkanSwapChainData * data)
static

Definition at line 377 of file vk_context.cc.

References BLI_assert, get(), and VKContext().

Referenced by blender::gpu::VKBackend::context_alloc().

◆ sync_backbuffer()

void blender::gpu::VKContext::sync_backbuffer ( )

Definition at line 59 of file vk_context.cc.

References blender::gpu::Context::back_left, deactivate_framebuffer(), ELEM, blender::gpu::Context::front_left, blender::gpu::GCaps, blender::gpu::Context::ghost_window_, GPU_ATTACHMENT_TEXTURE, GPU_FB_COLOR_ATTACHMENT0, GPU_texture_create_2d(), GPU_texture_free(), GPU_TEXTURE_USAGE_ATTACHMENT, GPU_TEXTURE_USAGE_SHADER_READ, has_active_framebuffer(), max_uu(), and blender::gpu::to_gpu_format().

Referenced by activate().

◆ update_pipeline_data() [1/2]

void blender::gpu::VKContext::update_pipeline_data ( GPUPrimType primitive,
VKVertexAttributeObject & vao,
render_graph::VKPipelineDataGraphics & r_pipeline_data )

Definition at line 287 of file vk_context.cc.

References active_framebuffer_get(), blender::gpu::VKBackend::device, ELEM, blender::gpu::VKShader::ensure_and_get_graphics_pipeline(), blender::gpu::VKDevice::extensions_get(), blender::gpu::VKBackend::get(), GPU_PRIM_LINE_LOOP, GPU_PRIM_LINE_STRIP, GPU_PRIM_LINE_STRIP_ADJ, GPU_PRIM_LINES, GPU_PRIM_LINES_ADJ, GPU_PRIM_POINTS, GPU_shader_uniform_1f(), blender::gpu::GPUStateMutable::line_width, blender::gpu::render_graph::VKPipelineDataGraphics::line_width, blender::gpu::StateManager::mutable_state, blender::gpu::render_graph::VKPipelineDataGraphics::pipeline_data, blender::gpu::GPUStateMutable::point_size, blender::gpu::Context::shader, state_manager_get(), blender::gpu::unwrap(), update_pipeline_data(), and blender::gpu::VKExtensions::wide_lines.

◆ update_pipeline_data() [2/2]

void blender::gpu::VKContext::update_pipeline_data ( render_graph::VKPipelineData & r_pipeline_data)

Update the give shader data with the current state of the context.

Definition at line 324 of file vk_context.cc.

References blender::gpu::VKShader::ensure_and_get_compute_pipeline(), blender::gpu::Context::shader, blender::gpu::unwrap(), and update_pipeline_data().

Referenced by update_pipeline_data(), and update_pipeline_data().

◆ VKDevice

friend class VKDevice
friend

Definition at line 42 of file vk_context.hh.

References VKDevice.

Referenced by activate(), flush_render_graph(), memory_statistics_get(), VKDevice, and ~VKContext().

Member Data Documentation

◆ discard_pool

VKDiscardPool blender::gpu::VKContext::discard_pool

Definition at line 77 of file vk_context.hh.

Referenced by flush_render_graph().

The documentation for this class was generated from the following files:
Generated on for Blender by  doxygen 1.16.1