#include <vk_shader.hh>

Inherits blender::gpu::Shader.

Public Member Functions
	VKShader (const char *name)

virtual	~VKShader ()

void	init (const shader::ShaderCreateInfo &info, bool is_batch_compilation) override

void	init () override

void	vertex_shader_from_glsl (MutableSpan< StringRefNull > sources) override

void	geometry_shader_from_glsl (MutableSpan< StringRefNull > sources) override

void	fragment_shader_from_glsl (MutableSpan< StringRefNull > sources) override

void	compute_shader_from_glsl (MutableSpan< StringRefNull > sources) override

bool	finalize (const shader::ShaderCreateInfo *info=nullptr) override

bool	finalize_post ()

bool	is_ready () const

void	warm_cache (int limit) override

void	bind (const shader::SpecializationConstants *constants_state) override

void	unbind () override

void	uniform_float (int location, int comp_len, int array_size, const float *data) override

void	uniform_int (int location, int comp_len, int array_size, const int *data) override

std::string	resources_declare (const shader::ShaderCreateInfo &info) const override

std::string	vertex_interface_declare (const shader::ShaderCreateInfo &info) const override

std::string	fragment_interface_declare (const shader::ShaderCreateInfo &info) const override

std::string	geometry_interface_declare (const shader::ShaderCreateInfo &info) const override

std::string	geometry_layout_declare (const shader::ShaderCreateInfo &info) const override

std::string	compute_layout_declare (const shader::ShaderCreateInfo &info) const override

VkPipeline	ensure_and_get_compute_pipeline (const shader::SpecializationConstants &constants_state)

VkPipeline	ensure_and_get_graphics_pipeline (GPUPrimType primitive, VKVertexAttributeObject &vao, VKStateManager &state_manager, VKFrameBuffer &framebuffer, shader::SpecializationConstants &constants_state)

const VKShaderInterface &	interface_get () const

bool	has_descriptor_set () const

VkDescriptorSetLayout	vk_descriptor_set_layout_get () const

Public Member Functions inherited from blender::gpu::Shader
std::string	defines_declare (const shader::ShaderCreateInfo &info) const

StringRefNull	name_get () const

void	parent_set (Shader *parent)

Shader *	parent_get () const

	Shader (const char *name)

virtual	~Shader ()

void	specialization_constants_init (const shader::ShaderCreateInfo &info)

Public Attributes
VKShaderModule	vertex_module

VKShaderModule	geometry_module

VKShaderModule	fragment_module

VKShaderModule	compute_module

bool	compilation_finished = false

bool	compilation_failed = false

VkPipelineLayout	vk_pipeline_layout = VK_NULL_HANDLE

VKPushConstants	push_constants

Public Attributes inherited from blender::gpu::Shader
ShaderInterface *	interface = nullptr

uint16_t	fragment_output_bits = 0

std::unique_ptr< const shader::SpecializationConstants >	constants

bool	is_polyline = false

Additional Inherited Members
Static Public Member Functions inherited from blender::gpu::Shader
static void	set_srgb_uniform (Context ctx, GPUShader shader)

static void	set_framebuffer_srgb_target (int use_srgb_to_linear)

Protected Member Functions inherited from blender::gpu::Shader
void	print_log (Span< StringRefNull > sources, const char log, const char stage, bool error, GPULogParser *parser)

Protected Attributes inherited from blender::gpu::Shader
char	name [64]

Shader *	parent_shader_ = nullptr

Detailed Description

Definition at line 25 of file vk_shader.hh.

Constructor & Destructor Documentation

◆ VKShader()

blender::gpu::VKShader::VKShader ( const char * name )

Definition at line 505 of file vk_shader.cc.

References blender::gpu::VKContext::get().

◆ ~VKShader()

blender::gpu::VKShader::~VKShader ( )

virtual

Definition at line 520 of file vk_shader.cc.

References blender::gpu::VKBackend::device, blender::gpu::VKPipelinePool::discard(), blender::gpu::VKDiscardPool::discard_pipeline_layout(), blender::gpu::VKDiscardPool::discard_pool_get(), blender::gpu::VKBackend::get(), blender::gpu::VKDevice::pipelines, and vk_pipeline_layout.

Member Function Documentation

◆ bind()

void blender::gpu::VKShader::bind ( const shader::SpecializationConstants * constants_state )

overridevirtual

Implements blender::gpu::Shader.

Definition at line 737 of file vk_shader.cc.

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

◆ compute_layout_declare()

std::string blender::gpu::VKShader::compute_layout_declare ( const shader::ShaderCreateInfo & info ) const

overridevirtual

Implements blender::gpu::Shader.

Definition at line 1214 of file vk_shader.cc.

References info.

◆ compute_shader_from_glsl()

void blender::gpu::VKShader::compute_shader_from_glsl ( MutableSpan< StringRefNull > sources )

overridevirtual

Implements blender::gpu::Shader.

Definition at line 583 of file vk_shader.cc.

References compute_module.

◆ ensure_and_get_compute_pipeline()

VkPipeline blender::gpu::VKShader::ensure_and_get_compute_pipeline ( const shader::SpecializationConstants & constants_state )

Definition at line 1319 of file vk_shader.cc.

References BLI_assert, compute_module, blender::gpu::VKBackend::device, blender::gpu::VKBackend::get(), blender::gpu::VKPipelinePool::get_or_create_compute_pipeline(), blender::gpu::Shader::name_get(), blender::gpu::debug::object_label(), blender::gpu::VKDevice::pipelines, blender::gpu::VKComputeInfo::specialization_constants, blender::gpu::shader::SpecializationConstants::values, blender::gpu::VKComputeInfo::vk_pipeline_layout, vk_pipeline_layout, blender::gpu::VKComputeInfo::vk_shader_module, and blender::gpu::VKShaderModule::vk_shader_module.

Referenced by finalize_post(), and blender::gpu::VKContext::update_pipeline_data().

◆ ensure_and_get_graphics_pipeline()

VkPipeline blender::gpu::VKShader::ensure_and_get_graphics_pipeline	(	GPUPrimType	primitive,
		VKVertexAttributeObject &	vao,
		VKStateManager &	state_manager,
		VKFrameBuffer &	framebuffer,
		shader::SpecializationConstants &	constants_state )

Definition at line 1348 of file vk_shader.cc.

Referenced by blender::gpu::VKContext::update_pipeline_data().

◆ finalize()

bool blender::gpu::VKShader::finalize ( const shader::ShaderCreateInfo * info = nullptr )

overridevirtual

Implements blender::gpu::Shader.

Definition at line 593 of file vk_shader.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), compilation_failed, compilation_finished, blender::gpu::VKBackend::device, finalize_post(), geometry_shader_from_glsl(), blender::gpu::VKBackend::get(), info, interface_get(), push_constants, and blender::gpu::VKShaderInterface::push_constants_layout_get().

◆ finalize_post()

bool blender::gpu::VKShader::finalize_post ( )

Definition at line 631 of file vk_shader.cc.

References compute_module, blender::gpu::Shader::constants, ensure_and_get_compute_pipeline(), fragment_module, geometry_module, result, and vertex_module.

Referenced by finalize().

◆ fragment_interface_declare()

std::string blender::gpu::VKShader::fragment_interface_declare ( const shader::ShaderCreateInfo & info ) const

overridevirtual

◆ fragment_shader_from_glsl()

void blender::gpu::VKShader::fragment_shader_from_glsl ( MutableSpan< StringRefNull > sources )

overridevirtual

Implements blender::gpu::Shader.

Definition at line 578 of file vk_shader.cc.

References fragment_module.

◆ geometry_interface_declare()

std::string blender::gpu::VKShader::geometry_interface_declare ( const shader::ShaderCreateInfo & info ) const

overridevirtual

Implements blender::gpu::Shader.

Definition at line 1148 of file vk_shader.cc.

References info, and blender::gpu::to_string().

◆ geometry_layout_declare()

std::string blender::gpu::VKShader::geometry_layout_declare ( const shader::ShaderCreateInfo & info ) const

overridevirtual

Implements blender::gpu::Shader.

Definition at line 1186 of file vk_shader.cc.

References blender::gpu::declare_emit_vertex(), blender::gpu::find_interface_by_name(), info, and blender::gpu::print_interface().

◆ geometry_shader_from_glsl()

void blender::gpu::VKShader::geometry_shader_from_glsl ( MutableSpan< StringRefNull > sources )

overridevirtual

Implements blender::gpu::Shader.

Definition at line 573 of file vk_shader.cc.

References geometry_module.

Referenced by finalize().

◆ has_descriptor_set()

bool blender::gpu::VKShader::has_descriptor_set ( ) const

inline

Some shaders don't have a descriptor set and should not bind any descriptor set to the pipeline. This function can be used to determine if a descriptor set can be bound when this shader or one of its pipelines are active.

Definition at line 108 of file vk_shader.hh.

◆ init() [1/2]

void blender::gpu::VKShader::init ( )

inlineoverridevirtual

Implements blender::gpu::Shader.

Definition at line 61 of file vk_shader.hh.

◆ init() [2/2]

void blender::gpu::VKShader::init	(	const shader::ShaderCreateInfo &	info,
		bool	is_batch_compilation )

overridevirtual

Implements blender::gpu::Shader.

Definition at line 510 of file vk_shader.cc.

References info, and blender::gpu::VKShaderInterface::init().

◆ interface_get()

const VKShaderInterface & blender::gpu::VKShader::interface_get ( ) const

Definition at line 1400 of file vk_shader.cc.

References BLI_assert_msg, and blender::gpu::Shader::interface.

Referenced by blender::gpu::VKDescriptorSetUpdator::bind_shader_resources(), ensure_and_get_graphics_pipeline(), finalize(), fragment_interface_declare(), and resources_declare().

◆ is_ready()

bool blender::gpu::VKShader::is_ready ( ) const

Check if needed compilation steps have been finished.

Returns true when all modules that needed compilation have finished their compilation steps. Compilations with errors are still considered finished. Returns false when compilation is still needed for one of the shader modules.

Definition at line 680 of file vk_shader.cc.

References compilation_finished.