Describe inputs & outputs, stage interfaces, resources and sources of a shader. If all data is correctly provided, this is all that is needed to create and compile a blender::gpu::Shader. More...

#include <gpu_shader_create_info.hh>

Inherited by blender::gpu::shader::GPUCodegenCreateInfo.

Classes
struct	ResourceString
struct	VertIn
struct	GeometryStageLayout
struct	ComputeStageLayout
struct	FragOut
struct	SubpassIn
struct	SharedVariable
struct	Sampler
struct	Image
struct	UniformBuf
struct	StorageBuf
struct	Resource
struct	PushConst

Public Types
using	Self = ShaderCreateInfo

Public Member Functions
Vector< Resource > &	resources_get_ (Frequency freq)
Vector< Resource >	resources_get_all_ () const
	ShaderCreateInfo (const char *name)
	~ShaderCreateInfo ()=default
Shaders in/outs (fixed function pipeline config)
Self &	vertex_in (int slot, Type type, StringRefNull name)
Self &	vertex_out (StageInterfaceInfo &interface)
Self &	geometry_layout (PrimitiveIn prim_in, PrimitiveOut prim_out, int max_vertices, int invocations=-1)
Self &	local_group_size (int local_size_x, int local_size_y=1, int local_size_z=1)
Self &	early_fragment_test (bool enable)
Self &	geometry_out (StageInterfaceInfo &interface)
Self &	fragment_out (int slot, Type type, StringRefNull name, DualBlend blend=DualBlend::NONE, int raster_order_group=-1)
Self &	subpass_in (int slot, Type type, ImageType img_type, StringRefNull name, int raster_order_group=-1)
Self &	shared_resource_descriptor (void(*fn)(ShaderCreateInfo &))
Shader compilation constants
Compilation constants are constants defined in the create info. They cannot be changed after the shader is created. It is a replacement to macros with added type safety.
Self &	compilation_constant (Type type, StringRefNull name, double default_value)
Shader specialization constants
Self &	specialization_constant (Type type, StringRefNull name, double default_value)
Compute shader Shared variables
Self &	shared_variable (Type type, StringRefNull name)
Resources bindings points
Self &	uniform_buf (int slot, StringRefNull type_name, StringRefNull name, Frequency freq=Frequency::PASS)
Self &	storage_buf (int slot, Qualifier qualifiers, StringRefNull type_name, StringRefNull name, Frequency freq=Frequency::PASS)
Self &	image (int slot, TextureFormat format, Qualifier qualifiers, ImageReadWriteType type, StringRefNull name, Frequency freq=Frequency::PASS)
Self &	sampler (int slot, ImageType type, StringRefNull name, Frequency freq=Frequency::PASS, GPUSamplerState sampler=GPUSamplerState::internal_sampler())
Shader Source
Self &	vertex_source (StringRefNull filename)
Self &	fragment_source (StringRefNull filename)
Self &	compute_source (StringRefNull filename)
Self &	vertex_function (StringRefNull function_name)
Self &	fragment_function (StringRefNull function_name)
Self &	compute_function (StringRefNull function_name)
Push constants
Data managed by blender::gpu::Shader. Can be set through uniform functions. Must be less than 128bytes.
Self &	push_constant (Type type, StringRefNull name, int array_size=0)
Defines
Self &	define (StringRefNull name, StringRefNull value="")
Self &	do_static_compilation (bool value)
Self &	builtins (BuiltinBits builtin)
Self &	depth_write (DepthWrite value)
Self &	auto_resource_location (bool value)
Self &	metal_backend_only (bool flag)
Additional Create Info
Used to share parts of the infos that are common to many shaders.
Self &	additional_info (StringRefNull info_name)
template<typename... Args>
Self &	additional_info (StringRefNull info_name, Args... args)
Typedef Sources
Some resource declarations might need some special structure defined. Adding a file using typedef_source will include it before the resource and interface definitions.
Self &	typedef_source (StringRefNull filename)
mtl_max_total_threads_per_threadgroup
max_total_threads_per_threadgroup - Provides compiler hint for maximum threadgroup size up front. Maximum value is 1024.
Self &	mtl_max_total_threads_per_threadgroup (ushort max_total_threads_per_threadgroup)
Recursive evaluation.
Flatten all dependency so that this descriptor contains all the data from the additional descriptors. This avoids tedious traversal in shader source creation.
void	finalize (const bool recursive=false)
void	resource_guard_defines (std::string &defines) const
std::string	check_error () const
bool	is_vulkan_compatible () const
void	validate_merge (const ShaderCreateInfo &other_info)
void	validate_vertex_attributes (const ShaderCreateInfo *other_info=nullptr)

Public Attributes
StringRefNull	name_
bool	do_static_compilation_ = false
bool	is_generated_ = true
bool	finalized_ = false
bool	auto_resource_location_ = false
bool	early_fragment_test_ = false
DepthWrite	depth_write_ = DepthWrite::UNCHANGED
bool	metal_backend_only_ = false
size_t	interface_names_size_ = 0
BuiltinBits	builtins_ = BuiltinBits::NONE
std::string	vertex_source_generated
std::string	fragment_source_generated
std::string	compute_source_generated
std::string	geometry_source_generated
std::string	typedef_source_generated
Vector< StringRefNull, 0 >	dependencies_generated
GeneratedSourceList	generated_sources
Vector< VertIn >	vertex_inputs_
GeometryStageLayout	geometry_layout_
ComputeStageLayout	compute_layout_
Vector< FragOut >	fragment_outputs_
Vector< SubpassIn >	subpass_inputs_
Vector< CompilationConstant, 0 >	compilation_constants_
Vector< SpecializationConstant >	specialization_constants_
Vector< SharedVariable, 0 >	shared_variables_
Vector< Resource >	pass_resources_
Vector< Resource >	batch_resources_
Vector< Resource >	geometry_resources_
Vector< StageInterfaceInfo * >	vertex_out_interfaces_
Vector< StageInterfaceInfo * >	geometry_out_interfaces_
Vector< PushConst >	push_constants_
Vector< StringRefNull >	typedef_sources_
StringRefNull	vertex_source_
StringRefNull	geometry_source_
StringRefNull	fragment_source_
StringRefNull	compute_source_
StringRefNull	vertex_entry_fn_ = "main"
StringRefNull	geometry_entry_fn_ = "main"
StringRefNull	fragment_entry_fn_ = "main"
StringRefNull	compute_entry_fn_ = "main"
Vector< std::array< StringRefNull, 2 > >	defines_
Vector< StringRefNull >	additional_infos_

Operators.
bool	operator== (const ShaderCreateInfo &b) const
bool	has_resource_type (Resource::BindType bind_type) const
bool	has_resource_image () const
std::ostream &	operator<< (std::ostream &stream, const ShaderCreateInfo &info)

Detailed Description

Describe inputs & outputs, stage interfaces, resources and sources of a shader. If all data is correctly provided, this is all that is needed to create and compile a blender::gpu::Shader.

IMPORTANT: All strings are references only. Make sure all the strings used by a ShaderCreateInfo are not freed until it is consumed or deleted.

Definition at line 686 of file gpu_shader_create_info.hh.

Member Typedef Documentation

◆ Self

using blender::gpu::shader::ShaderCreateInfo::Self = ShaderCreateInfo

Definition at line 1008 of file gpu_shader_create_info.hh.

Constructor & Destructor Documentation

◆ ShaderCreateInfo()

blender::gpu::shader::ShaderCreateInfo::ShaderCreateInfo ( const char * name )

inline

Definition at line 1005 of file gpu_shader_create_info.hh.

References name, and name_.

Referenced by finalize(), blender::gpu::shader::GPUCodegenCreateInfo::GPUCodegenCreateInfo(), operator<<, operator==(), resource_guard_defines(), shared_resource_descriptor(), validate_merge(), and validate_vertex_attributes().

◆ ~ShaderCreateInfo()

blender::gpu::shader::ShaderCreateInfo::~ShaderCreateInfo ( )

default

Member Function Documentation

◆ additional_info() [1/2]

Self & blender::gpu::shader::ShaderCreateInfo::additional_info ( StringRefNull info_name )

inline

Definition at line 1395 of file gpu_shader_create_info.hh.

References additional_infos_.

Referenced by additional_info(), blender::gpu::shader::GPUCodegen::generate_resources(), and blender::gpu::tests::gpu_shader_lib_test().

◆ additional_info() [2/2]

template<typename... Args>

Self & blender::gpu::shader::ShaderCreateInfo::additional_info	(	StringRefNull	info_name,
		Args...	args )

inline

Definition at line 1401 of file gpu_shader_create_info.hh.

References additional_info().

◆ auto_resource_location()

Self & blender::gpu::shader::ShaderCreateInfo::auto_resource_location ( bool value )

inline

Definition at line 1375 of file gpu_shader_create_info.hh.

References auto_resource_location_.

◆ builtins()

Self & blender::gpu::shader::ShaderCreateInfo::builtins ( BuiltinBits builtin )

inline

Definition at line 1362 of file gpu_shader_create_info.hh.

References builtins_.

Referenced by blender::gpu::tests::test_framebuffer_multi_viewport().

◆ check_error()

std::string blender::gpu::shader::ShaderCreateInfo::check_error ( ) const

Definition at line 280 of file gpu_shader_create_info.cc.

References blender::gpu::shader::BARYCENTRIC_COORD, builtins_, compilation_constants_, compute_source_, error(), fragment_source_, G, G_DEBUG_GPU, geometry_source_, i, is_vulkan_compatible(), blender::gpu::shader::LAYER, name, name_, shared_variables_, specialization_constants_, vertex_out_interfaces_, vertex_source_, and blender::gpu::shader::VIEWPORT_INDEX.

Referenced by blender::gpu::ShaderCompiler::compile().

◆ compilation_constant()

Self & blender::gpu::shader::ShaderCreateInfo::compilation_constant	(	Type	type,
		StringRefNull	name,
		double	default_value )

inline

Definition at line 1116 of file gpu_shader_create_info.hh.

References BLI_assert_msg, blender::gpu::shader::bool_t, compilation_constants_, blender::gpu::shader::SpecializationConstant::Value::i, blender::gpu::shader::int_t, interface_names_size_, blender::gpu::shader::CompilationConstant::name, name, blender::gpu::shader::CompilationConstant::type, blender::gpu::shader::SpecializationConstant::Value::u, blender::gpu::shader::uint_t, and blender::gpu::shader::CompilationConstant::value.

◆ compute_function()

Self & blender::gpu::shader::ShaderCreateInfo::compute_function ( StringRefNull function_name )

inline

Definition at line 1311 of file gpu_shader_create_info.hh.

References compute_entry_fn_.

◆ compute_source()

Self & blender::gpu::shader::ShaderCreateInfo::compute_source ( StringRefNull filename )

inline

Definition at line 1293 of file gpu_shader_create_info.hh.

References compute_source_.

Referenced by pygpu_shader_info_compute_source().

◆ define()

Self & blender::gpu::shader::ShaderCreateInfo::define	(	StringRefNull	name,
		StringRefNull	value = "" )

inline

Definition at line 1344 of file gpu_shader_create_info.hh.

References defines_, and name.

Referenced by pygpu_shader_info_define(), and blender::gpu::tests::test_framebuffer_subpass_input().

◆ depth_write()

Self & blender::gpu::shader::ShaderCreateInfo::depth_write ( DepthWrite value )

inline

Definition at line 1369 of file gpu_shader_create_info.hh.

References depth_write_.

Referenced by pygpu_shader_info_depth_write().

◆ do_static_compilation()

Self & blender::gpu::shader::ShaderCreateInfo::do_static_compilation ( bool value )

inline

Definition at line 1356 of file gpu_shader_create_info.hh.

References do_static_compilation_.

◆ early_fragment_test()

Self & blender::gpu::shader::ShaderCreateInfo::early_fragment_test ( bool enable )

inline

Force fragment tests before fragment shader invocation. IMPORTANT: This is incompatible with using the gl_FragDepth output.

Definition at line 1051 of file gpu_shader_create_info.hh.

References early_fragment_test_.

◆ finalize()

void blender::gpu::shader::ShaderCreateInfo::finalize ( const bool recursive = false )

Definition at line 115 of file gpu_shader_create_info.cc.

References blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), additional_infos_, auto_resource_location_, batch_resources_, BLI_assert, builtins_, compilation_constants_, compute_entry_fn_, compute_layout_, compute_source_, defines_, depth_write_, early_fragment_test_, error(), finalize(), finalized_, fragment_entry_fn_, fragment_outputs_, fragment_source_, geometry_entry_fn_, geometry_layout_, geometry_out_interfaces_, geometry_resources_, geometry_source_, gpu_shader_create_info_get(), blender::gpu::shader::ShaderCreateInfo::Resource::IMAGE, interface_names_size_, blender::StringRefBase::is_empty(), blender::gpu::shader::LAYER, blender::gpu::shader::ShaderCreateInfo::ComputeStageLayout::local_size_x, name_, pass_resources_, push_constants_, blender::gpu::shader::ShaderCreateInfo::Resource::SAMPLER, ShaderCreateInfo(), shared_variables_, specialization_constants_, blender::gpu::shader::ShaderCreateInfo::Resource::STORAGE_BUFFER, subpass_inputs_, typedef_sources_, blender::gpu::shader::UNCHANGED, blender::gpu::shader::ShaderCreateInfo::Resource::UNIFORM_BUFFER, validate_merge(), validate_vertex_attributes(), vertex_entry_fn_, vertex_inputs_, vertex_out_interfaces_, and vertex_source_.

Referenced by blender::compositor::CachedShader::CachedShader(), finalize(), and GPU_generate_pass().

◆ fragment_function()

Self & blender::gpu::shader::ShaderCreateInfo::fragment_function ( StringRefNull function_name )

inline

Definition at line 1305 of file gpu_shader_create_info.hh.

References fragment_entry_fn_.

◆ fragment_out()

Self & blender::gpu::shader::ShaderCreateInfo::fragment_out	(	int	slot,
		Type	type,
		StringRefNull	name,
		DualBlend	blend = DualBlend::NONE,
		int	raster_order_group = -1 )

inline

Definition at line 1069 of file gpu_shader_create_info.hh.

References blend(), fragment_outputs_, name, and blender::gpu::shader::NONE.

Referenced by pygpu_shader_info_fragment_out(), blender::gpu::tests::test_framebuffer_multi_viewport(), and blender::gpu::tests::test_framebuffer_subpass_input().

◆ fragment_source()

Self & blender::gpu::shader::ShaderCreateInfo::fragment_source ( StringRefNull filename )

inline

Definition at line 1287 of file gpu_shader_create_info.hh.

References fragment_source_.

Referenced by blender::gpu::tests::gpu_shader_lib_test(), pygpu_shader_info_fragment_source(), blender::gpu::tests::test_framebuffer_multi_viewport(), and blender::gpu::tests::test_framebuffer_subpass_input().

◆ geometry_layout()

Self & blender::gpu::shader::ShaderCreateInfo::geometry_layout	(	PrimitiveIn	prim_in,
		PrimitiveOut	prim_out,
		int	max_vertices,
		int	invocations = -1 )

inline

Definition at line 1027 of file gpu_shader_create_info.hh.

References geometry_layout_.

◆ geometry_out()

Self & blender::gpu::shader::ShaderCreateInfo::geometry_out ( StageInterfaceInfo & interface )

inline

Only needed if geometry shader is enabled. IMPORTANT: Input and output instance name will have respectively "_in" and "_out" suffix appended in the geometry shader IF AND ONLY IF the vertex_out interface instance name matches the geometry_out interface instance name.

Definition at line 1063 of file gpu_shader_create_info.hh.

References geometry_out_interfaces_.

◆ has_resource_image()

bool blender::gpu::shader::ShaderCreateInfo::has_resource_image ( ) const

inline

Definition at line 1566 of file gpu_shader_create_info.hh.

References has_resource_type(), and blender::gpu::shader::ShaderCreateInfo::Resource::IMAGE.

◆ has_resource_type()

bool blender::gpu::shader::ShaderCreateInfo::has_resource_type ( Resource::BindType bind_type ) const

inline

Definition at line 1546 of file gpu_shader_create_info.hh.

References batch_resources_, geometry_resources_, and pass_resources_.

Referenced by has_resource_image().

◆ image()

Self & blender::gpu::shader::ShaderCreateInfo::image	(	int	slot,
		TextureFormat	format,
		Qualifier	qualifiers,
		ImageReadWriteType	type,
		StringRefNull	name,
		Frequency	freq = Frequency::PASS )

inline

Definition at line 1241 of file gpu_shader_create_info.hh.

References blender::gpu::shader::ShaderCreateInfo::Image::format, blender::gpu::shader::ShaderCreateInfo::Resource::IMAGE, blender::gpu::shader::ShaderCreateInfo::Resource::image, interface_names_size_, blender::gpu::shader::ShaderCreateInfo::Image::name, name, blender::gpu::shader::PASS, blender::gpu::shader::ShaderCreateInfo::Image::qualifiers, resources_get_(), and blender::gpu::shader::ShaderCreateInfo::Image::type.

Referenced by pygpu_shader_info_image().

◆ is_vulkan_compatible()

bool blender::gpu::shader::ShaderCreateInfo::is_vulkan_compatible ( ) const

Definition at line 80 of file gpu_shader_create_info.cc.

References geometry_out_interfaces_, blender::gpu::shader::is_vulkan_compatible_interface(), and vertex_out_interfaces_.

Referenced by check_error().

◆ local_group_size()

Self & blender::gpu::shader::ShaderCreateInfo::local_group_size	(	int	local_size_x,
		int	local_size_y = 1,
		int	local_size_z = 1 )

inline

Definition at line 1039 of file gpu_shader_create_info.hh.

References compute_layout_.

Referenced by pygpu_shader_info_local_group_size().

◆ metal_backend_only()

Self & blender::gpu::shader::ShaderCreateInfo::metal_backend_only ( bool flag )

inline

Definition at line 1381 of file gpu_shader_create_info.hh.

References flag, and metal_backend_only_.

◆ mtl_max_total_threads_per_threadgroup()

Self & blender::gpu::shader::ShaderCreateInfo::mtl_max_total_threads_per_threadgroup ( ushort max_total_threads_per_threadgroup )

inline

Definition at line 1439 of file gpu_shader_create_info.hh.

References UNUSED_VARS.

◆ operator==()

bool blender::gpu::shader::ShaderCreateInfo::operator== ( const ShaderCreateInfo & b ) const

inline

◆ push_constant()

Self & blender::gpu::shader::ShaderCreateInfo::push_constant	(	Type	type,
		StringRefNull	name,
		int	array_size = 0 )

inline

Definition at line 1326 of file gpu_shader_create_info.hh.

References BLI_assert, BLI_assert_msg, interface_names_size_, name, push_constants_, and blender::gpu::shader::uint_t.

Referenced by pygpu_shader_info_push_constant().

◆ resource_guard_defines()

void blender::gpu::shader::ShaderCreateInfo::resource_guard_defines ( std::string & defines ) const

Definition at line 99 of file gpu_shader_create_info.cc.

References additional_infos_, gpu_shader_create_info_get(), name_, resource_guard_defines(), and ShaderCreateInfo().

Referenced by blender::gpu::ShaderCompiler::compile(), and resource_guard_defines().

◆ resources_get_()

Vector< Resource > & blender::gpu::shader::ShaderCreateInfo::resources_get_ ( Frequency freq )

inline

Definition at line 942 of file gpu_shader_create_info.hh.

References blender::gpu::shader::BATCH, batch_resources_, BLI_assert_unreachable, blender::gpu::shader::GEOMETRY, geometry_resources_, blender::gpu::shader::PASS, and pass_resources_.

Referenced by image(), sampler(), storage_buf(), and uniform_buf().

◆ resources_get_all_()

Vector< Resource > blender::gpu::shader::ShaderCreateInfo::resources_get_all_ ( ) const

inline

Definition at line 957 of file gpu_shader_create_info.hh.

References batch_resources_, blender::Vector< T, InlineBufferCapacity, Allocator >::extend(), geometry_resources_, and pass_resources_.

Referenced by blender::gpu::GLShaderInterface::GLShaderInterface(), gpu_pass_validate(), gpu_shader_create_info_compile(), blender::gpu::MSLGeneratorInterface::prepare_from_createinfo(), and validate_merge().

◆ sampler()

Self & blender::gpu::shader::ShaderCreateInfo::sampler	(	int	slot,
		ImageType	type,
		StringRefNull	name,
		Frequency	freq = Frequency::PASS,
		GPUSamplerState	sampler = GPUSamplerState::internal_sampler() )

inline

Definition at line 1258 of file gpu_shader_create_info.hh.

References interface_names_size_, GPUSamplerState::internal_sampler(), blender::gpu::shader::ShaderCreateInfo::Sampler::name, name, blender::gpu::shader::PASS, resources_get_(), blender::gpu::shader::ShaderCreateInfo::Resource::SAMPLER, blender::gpu::shader::ShaderCreateInfo::Resource::sampler, sampler(), blender::gpu::shader::ShaderCreateInfo::Sampler::type, and UNUSED_VARS.

Referenced by blender::gpu::shader::GPUCodegen::generate_resources(), pygpu_shader_info_sampler(), and sampler().

◆ shared_resource_descriptor()

Self & blender::gpu::shader::ShaderCreateInfo::shared_resource_descriptor ( void(* fn )(ShaderCreateInfo &) )

inline

Definition at line 1100 of file gpu_shader_create_info.hh.

References ShaderCreateInfo().

◆ shared_variable()

Self & blender::gpu::shader::ShaderCreateInfo::shared_variable	(	Type	type,
		StringRefNull	name )

inline

Definition at line 1201 of file gpu_shader_create_info.hh.

References name, and shared_variables_.

◆ specialization_constant()

Self & blender::gpu::shader::ShaderCreateInfo::specialization_constant	(	Type	type,
		StringRefNull	name,
		double	default_value )

inline

Definition at line 1166 of file gpu_shader_create_info.hh.

◆ storage_buf()

Self & blender::gpu::shader::ShaderCreateInfo::storage_buf	(	int	slot,
		Qualifier	qualifiers,
		StringRefNull	type_name,
		StringRefNull	name,
		Frequency	freq = Frequency::PASS )

inline

Definition at line 1226 of file gpu_shader_create_info.hh.

References interface_names_size_, blender::gpu::shader::ShaderCreateInfo::StorageBuf::name, name, blender::gpu::shader::PASS, blender::gpu::shader::ShaderCreateInfo::StorageBuf::qualifiers, resources_get_(), blender::gpu::shader::ShaderCreateInfo::Resource::STORAGE_BUFFER, blender::gpu::shader::ShaderCreateInfo::Resource::storagebuf, and blender::gpu::shader::ShaderCreateInfo::StorageBuf::type_name.

◆ subpass_in()

Self & blender::gpu::shader::ShaderCreateInfo::subpass_in	(	int	slot,
		Type	type,
		ImageType	img_type,
		StringRefNull	name,
		int	raster_order_group = -1 )

inline

Allows to fetch frame-buffer values from previous render sub-pass.

On Apple Silicon, the additional raster_order_group is there to set the sub-pass dependencies. Any sub-pass input need to have the same raster_order_group defined in the shader writing them.

IMPORTANT: Currently emulated on all backend except Metal. This is only for debugging purpose as it is too slow to be viable.

TODO(fclem): Vulkan can implement that using subpassInput. However sub-pass boundaries might be difficult to inject implicitly and will require more high level changes. TODO(fclem): OpenGL can emulate that using GL_EXT_shader_framebuffer_fetch.

Definition at line 1093 of file gpu_shader_create_info.hh.

References name, and subpass_inputs_.

Referenced by blender::gpu::tests::test_framebuffer_subpass_input().

◆ typedef_source()

Self & blender::gpu::shader::ShaderCreateInfo::typedef_source ( StringRefNull filename )

inline

Definition at line 1418 of file gpu_shader_create_info.hh.

References typedef_sources_.

Referenced by pygpu_shader_info_typedef_source().

◆ uniform_buf()

Self & blender::gpu::shader::ShaderCreateInfo::uniform_buf	(	int	slot,
		StringRefNull	type_name,
		StringRefNull	name,
		Frequency	freq = Frequency::PASS )

inline

Definition at line 1213 of file gpu_shader_create_info.hh.

References interface_names_size_, blender::gpu::shader::ShaderCreateInfo::UniformBuf::name, name, blender::gpu::shader::PASS, resources_get_(), blender::gpu::shader::ShaderCreateInfo::UniformBuf::type_name, blender::gpu::shader::ShaderCreateInfo::Resource::UNIFORM_BUFFER, and blender::gpu::shader::ShaderCreateInfo::Resource::uniformbuf.

Referenced by blender::gpu::shader::GPUCodegen::generate_resources(), and pygpu_shader_info_uniform_buf().

◆ validate_merge()

void blender::gpu::shader::ShaderCreateInfo::validate_merge ( const ShaderCreateInfo & other_info )

Error detection that some backend compilers do not complain about.

Definition at line 378 of file gpu_shader_create_info.cc.

Referenced by finalize().

◆ validate_vertex_attributes()

void blender::gpu::shader::ShaderCreateInfo::validate_vertex_attributes ( const ShaderCreateInfo * other_info = nullptr )

Definition at line 451 of file gpu_shader_create_info.cc.

References BLI_assert, blender::gpu::shader::float4x4_t, i, name_, ShaderCreateInfo(), and vertex_inputs_.

Referenced by finalize().

◆ vertex_function()

Self & blender::gpu::shader::ShaderCreateInfo::vertex_function ( StringRefNull function_name )

inline

Definition at line 1299 of file gpu_shader_create_info.hh.

References vertex_entry_fn_.

◆ vertex_in()

Self & blender::gpu::shader::ShaderCreateInfo::vertex_in	(	int	slot,
		Type	type,
		StringRefNull	name )

inline

Definition at line 1014 of file gpu_shader_create_info.hh.

References interface_names_size_, name, and vertex_inputs_.

Referenced by blender::gpu::shader::GPUCodegen::generate_attribs(), and pygpu_shader_info_vertex_in().

◆ vertex_out()

Self & blender::gpu::shader::ShaderCreateInfo::vertex_out ( StageInterfaceInfo & interface )

inline

Definition at line 1021 of file gpu_shader_create_info.hh.

References vertex_out_interfaces_.

Referenced by blender::gpu::shader::GPUCodegen::generate_attribs(), and pygpu_shader_info_vertex_out().

◆ vertex_source()

Self & blender::gpu::shader::ShaderCreateInfo::vertex_source ( StringRefNull filename )

inline

Definition at line 1281 of file gpu_shader_create_info.hh.

References vertex_source_.

Referenced by pygpu_shader_info_vertex_source(), blender::gpu::tests::test_framebuffer_multi_viewport(), and blender::gpu::tests::test_framebuffer_subpass_input().

◆ operator<<

std::ostream & operator<<	(	std::ostream &	stream,
		const ShaderCreateInfo &	info )

friend

Debug print

Definition at line 1510 of file gpu_shader_create_info.hh.

References batch_resources_, geometry_resources_, blender::gpu::shader::ShaderCreateInfo::Resource::IMAGE, pass_resources_, blender::gpu::print_resource(), blender::gpu::shader::ShaderCreateInfo::Resource::SAMPLER, ShaderCreateInfo(), blender::gpu::shader::ShaderCreateInfo::Resource::STORAGE_BUFFER, and blender::gpu::shader::ShaderCreateInfo::Resource::UNIFORM_BUFFER.

Member Data Documentation

◆ additional_infos_

Vector<StringRefNull> blender::gpu::shader::ShaderCreateInfo::additional_infos_

Name of other infos to recursively merge with this one. No data slot must overlap otherwise we throw an error.

Definition at line 997 of file gpu_shader_create_info.hh.

Referenced by additional_info(), finalize(), operator==(), and resource_guard_defines().

◆ auto_resource_location_

bool blender::gpu::shader::ShaderCreateInfo::auto_resource_location_ = false

If true, all resources will have an automatic location assigned.

Definition at line 696 of file gpu_shader_create_info.hh.

Referenced by auto_resource_location(), finalize(), blender::gpu::GLShader::resources_declare(), and validate_merge().

◆ batch_resources_

Vector<Resource> blender::gpu::shader::ShaderCreateInfo::batch_resources_

Definition at line 940 of file gpu_shader_create_info.hh.

Referenced by finalize(), has_resource_type(), blender::gpu::VKShaderInterface::init(), operator<<, operator==(), blender::gpu::GLShader::resources_declare(), blender::gpu::MTLShader::resources_declare(), blender::gpu::VKShader::resources_declare(), resources_get_(), resources_get_all_(), blender::gpu::ShaderInterface::set_image_formats_from_info(), and validate_merge().

◆ builtins_

BuiltinBits blender::gpu::shader::ShaderCreateInfo::builtins_ = BuiltinBits::NONE

Manually set builtins.

Definition at line 710 of file gpu_shader_create_info.hh.

Referenced by builtins(), check_error(), blender::gpu::MTLShader::finalize(), finalize(), blender::gpu::GLShader::fragment_interface_declare(), blender::gpu::VKShader::fragment_interface_declare(), blender::gpu::VKShaderInterface::init(), operator==(), blender::gpu::GLShader::vertex_interface_declare(), and blender::gpu::VKShader::vertex_interface_declare().

◆ compilation_constants_

Vector<CompilationConstant, 0> blender::gpu::shader::ShaderCreateInfo::compilation_constants_

Definition at line 851 of file gpu_shader_create_info.hh.

Referenced by check_error(), compilation_constant(), finalize(), blender::gpu::generate_compilation_constant_declarations(), blender::gpu::GLShader::resources_declare(), and blender::gpu::VKShader::resources_declare().

◆ compute_entry_fn_

StringRefNull blender::gpu::shader::ShaderCreateInfo::compute_entry_fn_ = "main"

Definition at line 990 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::ShaderCompiler::compile(), compute_function(), and finalize().

◆ compute_layout_

ComputeStageLayout blender::gpu::shader::ShaderCreateInfo::compute_layout_

Definition at line 809 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::GLShader::compute_layout_declare(), blender::gpu::VKShader::compute_layout_declare(), blender::gpu::MTLShader::finalize(), finalize(), local_group_size(), and operator==().

◆ compute_source_

StringRefNull blender::gpu::shader::ShaderCreateInfo::compute_source_

Definition at line 988 of file gpu_shader_create_info.hh.

Referenced by check_error(), blender::gpu::ShaderCompiler::compile(), compute_source(), finalize(), blender::gpu::VKShader::init(), blender::gpu::tests::ShaderSpecializationConst::init_shader(), and operator==().

◆ compute_source_generated

std::string blender::gpu::shader::ShaderCreateInfo::compute_source_generated

Definition at line 714 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::ShaderCompiler::compile(), blender::gpu::VKShader::init(), operator==(), and pygpu_shader_info_compute_source().

◆ defines_

Vector<std::array<StringRefNull, 2> > blender::gpu::shader::ShaderCreateInfo::defines_

Definition at line 992 of file gpu_shader_create_info.hh.

Referenced by define(), blender::gpu::Shader::defines_declare(), finalize(), and operator==().

◆ dependencies_generated

Vector<StringRefNull, 0> blender::gpu::shader::ShaderCreateInfo::dependencies_generated

Manually set generated dependencies file names.

Definition at line 718 of file gpu_shader_create_info.hh.

◆ depth_write_

DepthWrite blender::gpu::shader::ShaderCreateInfo::depth_write_ = DepthWrite::UNCHANGED

Allow optimization when fragment shader writes to gl_FragDepth.

Definition at line 700 of file gpu_shader_create_info.hh.

Referenced by depth_write(), finalize(), blender::gpu::GLShader::fragment_interface_declare(), and blender::gpu::VKShader::fragment_interface_declare().

◆ do_static_compilation_

bool blender::gpu::shader::ShaderCreateInfo::do_static_compilation_ = false

True if the shader is static and can be pre-compiled at compile time.

Definition at line 690 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::ShaderCompiler::compile(), do_static_compilation(), and blender::gpu::VKShader::init().

◆ early_fragment_test_

bool blender::gpu::shader::ShaderCreateInfo::early_fragment_test_ = false

If true, force depth and stencil tests to always happen before fragment shader invocation.

Definition at line 698 of file gpu_shader_create_info.hh.

Referenced by early_fragment_test(), finalize(), blender::gpu::GLShader::fragment_interface_declare(), and blender::gpu::VKShader::fragment_interface_declare().

◆ finalized_

bool blender::gpu::shader::ShaderCreateInfo::finalized_ = false

If true, all additionally linked create info will be merged into this one.

Definition at line 694 of file gpu_shader_create_info.hh.

Referenced by finalize().

◆ fragment_entry_fn_

StringRefNull blender::gpu::shader::ShaderCreateInfo::fragment_entry_fn_ = "main"

Definition at line 990 of file gpu_shader_create_info.hh.

Referenced by finalize(), and fragment_function().

◆ fragment_outputs_

Vector<FragOut> blender::gpu::shader::ShaderCreateInfo::fragment_outputs_

Definition at line 829 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::ShaderCompiler::compile(), finalize(), blender::gpu::GLShader::fragment_interface_declare(), blender::gpu::MTLShader::fragment_interface_declare(), blender::gpu::VKShader::fragment_interface_declare(), fragment_out(), and operator==().

◆ fragment_source_

StringRefNull blender::gpu::shader::ShaderCreateInfo::fragment_source_

Definition at line 988 of file gpu_shader_create_info.hh.

Referenced by check_error(), blender::gpu::ShaderCompiler::compile(), finalize(), blender::gpu::VKShader::fragment_interface_declare(), fragment_source(), and operator==().

◆ fragment_source_generated

std::string blender::gpu::shader::ShaderCreateInfo::fragment_source_generated

Definition at line 713 of file gpu_shader_create_info.hh.

Referenced by operator==(), and pygpu_shader_info_fragment_source().

◆ generated_sources

GeneratedSourceList blender::gpu::shader::ShaderCreateInfo::generated_sources

Definition at line 720 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::ShaderCompiler::compile().

◆ geometry_entry_fn_

StringRefNull blender::gpu::shader::ShaderCreateInfo::geometry_entry_fn_ = "main"

Definition at line 989 of file gpu_shader_create_info.hh.

Referenced by finalize().

◆ geometry_layout_

GeometryStageLayout blender::gpu::shader::ShaderCreateInfo::geometry_layout_

Definition at line 794 of file gpu_shader_create_info.hh.

Referenced by finalize(), blender::gpu::VKShader::geometry_interface_declare(), geometry_layout(), blender::gpu::GLShader::geometry_layout_declare(), and operator==().

◆ geometry_out_interfaces_

Vector<StageInterfaceInfo *> blender::gpu::shader::ShaderCreateInfo::geometry_out_interfaces_

Definition at line 967 of file gpu_shader_create_info.hh.

Referenced by finalize(), blender::gpu::GLShader::fragment_interface_declare(), blender::gpu::VKShader::fragment_interface_declare(), blender::gpu::GLShader::geometry_interface_declare(), blender::gpu::VKShader::geometry_layout_declare(), geometry_out(), is_vulkan_compatible(), and operator==().

◆ geometry_resources_

Vector<Resource> blender::gpu::shader::ShaderCreateInfo::geometry_resources_

Definition at line 940 of file gpu_shader_create_info.hh.

Referenced by finalize(), blender::gpu::GLShaderInterface::GLShaderInterface(), has_resource_type(), blender::gpu::VKShaderInterface::init(), operator<<, operator==(), blender::gpu::MTLShaderInterface::prepare_common_shader_inputs(), blender::gpu::GLShader::resources_declare(), blender::gpu::MTLShader::resources_declare(), blender::gpu::VKShader::resources_declare(), resources_get_(), resources_get_all_(), blender::gpu::ShaderInterface::set_image_formats_from_info(), and validate_merge().

◆ geometry_source_

StringRefNull blender::gpu::shader::ShaderCreateInfo::geometry_source_

Definition at line 988 of file gpu_shader_create_info.hh.

Referenced by check_error(), blender::gpu::ShaderCompiler::compile(), finalize(), blender::gpu::GLShader::fragment_interface_declare(), blender::gpu::VKShader::fragment_interface_declare(), operator==(), blender::gpu::GLShader::vertex_interface_declare(), and blender::gpu::VKShader::vertex_interface_declare().

◆ geometry_source_generated

std::string blender::gpu::shader::ShaderCreateInfo::geometry_source_generated

Definition at line 715 of file gpu_shader_create_info.hh.

◆ interface_names_size_

size_t blender::gpu::shader::ShaderCreateInfo::interface_names_size_ = 0

Maximum length of all the resource names including each null terminator. Only for names used by #gpu::ShaderInterface.

Definition at line 708 of file gpu_shader_create_info.hh.

Referenced by compilation_constant(), finalize(), blender::gpu::GLShaderInterface::GLShaderInterface(), image(), blender::gpu::VKShaderInterface::init(), push_constant(), sampler(), specialization_constant(), storage_buf(), uniform_buf(), and vertex_in().

◆ is_generated_

bool blender::gpu::shader::ShaderCreateInfo::is_generated_ = true

True if the shader is not part of gpu_shader_create_info_list.

Definition at line 692 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::ShaderCompiler::compile().

◆ metal_backend_only_

bool blender::gpu::shader::ShaderCreateInfo::metal_backend_only_ = false

GPU Backend compatibility flag. Temporary requirement until Metal enablement is fully complete.

Definition at line 703 of file gpu_shader_create_info.hh.

Referenced by metal_backend_only().

◆ name_

StringRefNull blender::gpu::shader::ShaderCreateInfo::name_

Shader name for debugging.

Definition at line 688 of file gpu_shader_create_info.hh.

Referenced by check_error(), blender::gpu::ShaderCompiler::compile(), finalize(), gpu_shader_create_info_compile(), blender::gpu::shader::GPUCodegenCreateInfo::GPUCodegenCreateInfo(), resource_guard_defines(), ShaderCreateInfo(), validate_merge(), and validate_vertex_attributes().

◆ pass_resources_

Vector<Resource> blender::gpu::shader::ShaderCreateInfo::pass_resources_

Resources are grouped by frequency of change. Pass resources are meant to be valid for the whole pass. Batch resources can be changed in a more granular manner (per object/material). Geometry resources can be changed in a very granular manner (per draw-call). Misuse will only produce suboptimal performance.

Definition at line 940 of file gpu_shader_create_info.hh.

Referenced by blender::compositor::CachedShader::CachedShader(), finalize(), has_resource_type(), blender::gpu::VKShaderInterface::init(), operator<<, operator==(), blender::gpu::GLShader::resources_declare(), blender::gpu::MTLShader::resources_declare(), blender::gpu::VKShader::resources_declare(), resources_get_(), resources_get_all_(), blender::gpu::ShaderInterface::set_image_formats_from_info(), and validate_merge().

◆ push_constants_

Vector<PushConst> blender::gpu::shader::ShaderCreateInfo::push_constants_

Definition at line 983 of file gpu_shader_create_info.hh.

Referenced by constants_calc_size(), blender::gpu::VKPushConstants::Layout::determine_storage_type(), finalize(), blender::gpu::GLShaderInterface::GLShaderInterface(), blender::gpu::VKShaderInterface::init(), blender::gpu::init_struct(), operator==(), push_constant(), blender::gpu::GLShader::resources_declare(), and blender::gpu::VKShader::resources_declare().

◆ shared_variables_

Vector<SharedVariable, 0> blender::gpu::shader::ShaderCreateInfo::shared_variables_

Definition at line 859 of file gpu_shader_create_info.hh.

Referenced by check_error(), finalize(), blender::gpu::MSLGeneratorInterface::generate_msl_compute_entry_stub(), blender::gpu::GLShader::resources_declare(), blender::gpu::MTLShader::resources_declare(), blender::gpu::VKShader::resources_declare(), shared_variable(), blender::gpu::shared_variable_args(), blender::gpu::shared_variable_assign(), blender::gpu::shared_variable_declare(), and blender::gpu::shared_variable_pass().

◆ specialization_constants_

Vector<SpecializationConstant> blender::gpu::shader::ShaderCreateInfo::specialization_constants_

Definition at line 852 of file gpu_shader_create_info.hh.

Referenced by check_error(), finalize(), blender::gpu::generate_specialization_constant_declarations(), blender::gpu::GLShaderInterface::GLShaderInterface(), blender::gpu::GLShader::init(), blender::gpu::VKShaderInterface::init(), blender::gpu::GLShader::resources_declare(), blender::gpu::VKShader::resources_declare(), specialization_constant(), and blender::gpu::Shader::specialization_constants_init().

◆ subpass_inputs_

Vector<SubpassIn> blender::gpu::shader::ShaderCreateInfo::subpass_inputs_

Definition at line 849 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::MTLShader::finalize(), finalize(), blender::gpu::GLShader::fragment_interface_declare(), blender::gpu::MTLShader::fragment_interface_declare(), blender::gpu::VKShader::fragment_interface_declare(), blender::gpu::VKShaderInterface::init(), operator==(), and subpass_in().

◆ typedef_source_generated

std::string blender::gpu::shader::ShaderCreateInfo::typedef_source_generated

Definition at line 716 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::ShaderCompiler::compile(), blender::gpu::shader::GPUCodegen::generate_resources(), operator==(), and pygpu_shader_info_typedef_source().

◆ typedef_sources_

Vector<StringRefNull> blender::gpu::shader::ShaderCreateInfo::typedef_sources_

Definition at line 986 of file gpu_shader_create_info.hh.

Referenced by blender::gpu::ShaderCompiler::compile(), finalize(), operator==(), pygpu_shader_info_typedef_source(), and typedef_source().

◆ vertex_entry_fn_

StringRefNull blender::gpu::shader::ShaderCreateInfo::vertex_entry_fn_ = "main"

Definition at line 989 of file gpu_shader_create_info.hh.

Referenced by finalize(), and vertex_function().

◆ vertex_inputs_

Vector<VertIn> blender::gpu::shader::ShaderCreateInfo::vertex_inputs_

Definition at line 776 of file gpu_shader_create_info.hh.

Referenced by finalize(), blender::gpu::GLShaderInterface::GLShaderInterface(), blender::gpu::VKShaderInterface::init(), operator==(), blender::gpu::MSLGeneratorInterface::prepare_from_createinfo(), validate_vertex_attributes(), vertex_in(), blender::gpu::GLShader::vertex_interface_declare(), blender::gpu::MTLShader::vertex_interface_declare(), and blender::gpu::VKShader::vertex_interface_declare().

◆ vertex_out_interfaces_

Vector<StageInterfaceInfo *> blender::gpu::shader::ShaderCreateInfo::vertex_out_interfaces_

Definition at line 966 of file gpu_shader_create_info.hh.

Referenced by check_error(), finalize(), blender::gpu::GLShader::fragment_interface_declare(), blender::gpu::VKShader::fragment_interface_declare(), blender::gpu::GLShader::geometry_interface_declare(), blender::gpu::VKShader::geometry_layout_declare(), is_vulkan_compatible(), operator==(), blender::gpu::GLShader::vertex_interface_declare(), blender::gpu::VKShader::vertex_interface_declare(), and vertex_out().

◆ vertex_source_

StringRefNull blender::gpu::shader::ShaderCreateInfo::vertex_source_

Definition at line 988 of file gpu_shader_create_info.hh.

Referenced by check_error(), blender::gpu::ShaderCompiler::compile(), finalize(), operator==(), and vertex_source().

◆ vertex_source_generated

std::string blender::gpu::shader::ShaderCreateInfo::vertex_source_generated

Manually set generated code.

Definition at line 712 of file gpu_shader_create_info.hh.

Referenced by operator==(), and pygpu_shader_info_vertex_source().

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

Classes

Public Types

Public Member Functions

Public Attributes

Operators.

Detailed Description

Member Typedef Documentation

◆ Self

Constructor & Destructor Documentation

◆ ShaderCreateInfo()

◆ ~ShaderCreateInfo()

Member Function Documentation

◆ additional_info() [1/2]

◆ additional_info() [2/2]

◆ auto_resource_location()

◆ builtins()

◆ check_error()

◆ compilation_constant()

◆ compute_function()

◆ compute_source()

◆ define()

◆ depth_write()

◆ do_static_compilation()

◆ early_fragment_test()

◆ finalize()

◆ fragment_function()

◆ fragment_out()

◆ fragment_source()

◆ geometry_layout()

◆ geometry_out()

◆ has_resource_image()

◆ has_resource_type()

◆ image()

◆ is_vulkan_compatible()

◆ local_group_size()

◆ metal_backend_only()

◆ mtl_max_total_threads_per_threadgroup()

◆ operator==()

◆ push_constant()

◆ resource_guard_defines()

◆ resources_get_()

◆ resources_get_all_()

◆ sampler()

◆ shared_resource_descriptor()

◆ shared_variable()

◆ specialization_constant()

◆ storage_buf()

◆ subpass_in()

◆ typedef_source()

◆ uniform_buf()

◆ validate_merge()

◆ validate_vertex_attributes()

◆ vertex_function()

◆ vertex_in()

◆ vertex_out()

◆ vertex_source()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ additional_infos_

◆ auto_resource_location_

◆ batch_resources_

◆ builtins_

◆ compilation_constants_

◆ compute_entry_fn_

◆ compute_layout_

◆ compute_source_

◆ compute_source_generated

◆ defines_

◆ dependencies_generated

◆ depth_write_

◆ do_static_compilation_

◆ early_fragment_test_

◆ finalized_

◆ fragment_entry_fn_

◆ fragment_outputs_

◆ fragment_source_

◆ fragment_source_generated

◆ generated_sources

◆ geometry_entry_fn_