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

#include <vk_context.hh>

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

Public Member Functions

const render_graph::VKRenderGraph & render_graph () const
render_graph::VKRenderGraph & render_graph ()
 VKContext (GHOST_IWindow *ghost_window, GHOST_IContext *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 *name, int index) 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
VKBufferPool push_constants_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
bool debug_pipeline_creation = 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, bool wait_for_submission)
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 (const VKFrameBuffer &framebuffer, GPUPrimType primitive, VKVertexInputDescriptionPool::Key vertex_input_key, render_graph::VKPipelineDataGraphics &r_pipeline_data)

Additional Inherited Members

Static Public Attributes inherited from blender::gpu::Context
static std::atomic< 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_
GHOST_IWindow * ghost_window_

Detailed Description

Definition at line 42 of file vk_context.hh.

Constructor & Destructor Documentation

◆ VKContext()

◆ ~VKContext()

Member Function Documentation

◆ activate()

◆ activate_framebuffer()

◆ active_framebuffer_get()

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

◆ begin_frame()

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

Implements blender::gpu::Context.

Definition at line 155 of file vk_context.cc.

◆ deactivate()

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

◆ deactivate_framebuffer()

◆ debug_capture_begin()

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

◆ debug_capture_end()

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

◆ debug_capture_scope_begin()

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

◆ 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.

◆ debug_capture_scope_end()

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

◆ debug_group_begin()

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

◆ debug_group_end()

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

◆ debug_unbind_all_ssbo()

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

◆ debug_unbind_all_ubo()

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

◆ descriptor_pools_get()

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

Definition at line 228 of file vk_context.cc.

◆ descriptor_set_get()

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

Definition at line 233 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 157 of file vk_context.cc.

◆ finish()

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

◆ flush()

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

◆ flush_render_graph()

◆ get()

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

Definition at line 148 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::VKTopLevelAS::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::VKBottomLevelAS::build(), blender::gpu::VKTopLevelAS::build(), 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::VKIndexBuffer::copy_sub(), blender::gpu::VKStorageBuffer::copy_sub(), blender::gpu::VKVertexBuffer::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::VKWorkInFlight::end_work(), blender::gpu::VKShader::ensure_and_get_graphics_pipeline(), 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::VKTexturePool::release_texture(), 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::VKIndexBuffer::update_sub(), blender::gpu::VKTexture::update_sub(), blender::gpu::VKVertexBuffer::update_sub(), blender::gpu::VKVertexBuffer::upload_data(), VKContext(), 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 545 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 277 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

◆ openxr_acquire_framebuffer_image_callback()

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

Definition at line 564 of file vk_context.cc.

References blender::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 571 of file vk_context.cc.

References blender::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 85 of file vk_context.hh.

◆ render_graph() [2/2]

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

Definition at line 81 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 292 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 ( )

◆ specialization_constants_set()

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

Definition at line 538 of file vk_context.cc.

◆ state_manager_get()

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

◆ swap_buffer_acquired_callback()

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

Definition at line 418 of file vk_context.cc.

References blender::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,
bool wait_for_submission )
static

Definition at line 425 of file vk_context.cc.

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

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

◆ sync_backbuffer()

◆ update_pipeline_data() [1/2]

void blender::gpu::VKContext::update_pipeline_data ( const VKFrameBuffer & framebuffer,
GPUPrimType primitive,
VKVertexInputDescriptionPool::Key vertex_input_key,
render_graph::VKPipelineDataGraphics & r_pipeline_data )

Definition at line 306 of file vk_context.cc.

References blender::gpu::VKBackend::device, ELEM, blender::gpu::VKShader::ensure_and_get_graphics_pipeline(), blender::gpu::VKExtensions::extended_dynamic_state, blender::gpu::VKDevice::extensions_get(), blender::gpu::render_graph::VKPipelineDataGraphics::front_face, blender::gpu::VKBackend::get(), blender::GPU_PRIM_LINE_LOOP, blender::GPU_PRIM_LINE_STRIP, blender::GPU_PRIM_LINE_STRIP_ADJ, blender::GPU_PRIM_LINES, blender::GPU_PRIM_LINES_ADJ, blender::GPU_PRIM_POINTS, blender::GPU_shader_uniform_1f(), blender::GPU_STENCIL_NONE, blender::gpu::render_graph::VKPipelineDataGraphics::line_width, blender::gpu::StateManager::mutable_state, blender::gpu::render_graph::VKPipelineDataGraphics::pipeline_data, point_size, blender::gpu::render_graph::VKViewportData::scissors, blender::gpu::Context::shader, blender::gpu::StateManager::state, blender::gpu::Context::state_manager, state_manager_get(), blender::gpu::VKFrameBuffer::stencil_attachment_format_get(), blender::gpu::render_graph::VKPipelineDataGraphics::stencil_state, blender::gpu::unwrap(), update_pipeline_data(), blender::gpu::render_graph::VKPipelineDataGraphics::vertex_input_description, blender::gpu::VKExtensions::vertex_input_dynamic_state, blender::gpu::render_graph::VKPipelineDataGraphics::viewport, blender::gpu::render_graph::VKViewportData::viewports, blender::gpu::VKFrameBuffer::vk_render_areas_append(), blender::gpu::VKFrameBuffer::vk_viewports_append(), VKDevice, 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 374 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

Member Data Documentation

◆ discard_pool

VKDiscardPool blender::gpu::VKContext::discard_pool

Definition at line 78 of file vk_context.hh.

Referenced by flush_render_graph().

◆ push_constants_pool

VKBufferPool blender::gpu::VKContext::push_constants_pool

Definition at line 79 of file vk_context.hh.

Referenced by flush_render_graph(), and VKContext().


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