Public Member Functions
	GPUSource (const char path, const char file, const char datatoc, GPUFunctionDictionnary g_functions, GPUPrintFormatMap *g_formats)
void	print_error (const StringRef &input, int64_t offset, const StringRef message)
void	check_no_quotes ()
void	quote_preprocess ()
void	small_types_check ()
void	enum_preprocess ()
void	material_functions_parse (GPUFunctionDictionnary *g_functions)
void	char_literals_preprocess ()
void	string_preprocess ()
void	printf_preprocess (GPUPrintFormatMap *format_map)
int	init_dependencies (const GPUSourceDictionnary &dict, const GPUFunctionDictionnary &g_functions)
void	build (Vector< const char * > &result) const
shader::BuiltinBits	builtins_get () const
bool	is_from_material_library () const

Static Public Member Functions
static bool	is_in_comment (const StringRef &input, int64_t offset)
template<bool check_whole_word = true, bool reversed = false, typename T>
static int64_t	find_str (const StringRef &input, const T keyword, int64_t offset=0)

Public Attributes
StringRefNull	fullpath
StringRefNull	filename
StringRefNull	source
Vector< GPUSource * >	dependencies
bool	dependencies_init = false
shader::BuiltinBits	builtins = shader::BuiltinBits::NONE
std::string	processed_source

Detailed Description

Definition at line 46 of file gpu_shader_dependency.cc.

Constructor & Destructor Documentation

◆ GPUSource()

blender::gpu::GPUSource::GPUSource	(	const char *	path,
		const char *	file,
		const char *	datatoc,
		GPUFunctionDictionnary *	g_functions,
		GPUPrintFormatMap *	g_formats )

inline

Definition at line 55 of file gpu_shader_dependency.cc.

References builtins, check_no_quotes(), ELEM, else, filename, fullpath, g_formats, g_functions, if(), blender::StringRefBase::not_found, source, and blender::gpu::shader::USE_DEBUG_DRAW.

Referenced by init_dependencies(), and material_functions_parse().

Member Function Documentation

◆ build()

void blender::gpu::GPUSource::build ( Vector< const char * > & result ) const

inline

Definition at line 1069 of file gpu_shader_dependency.cc.

References dependencies, result, and source.

Referenced by blender::gpu::shader::gpu_shader_dependency_get_resolved_source().

◆ builtins_get()

shader::BuiltinBits blender::gpu::GPUSource::builtins_get ( ) const

inline

Definition at line 1077 of file gpu_shader_dependency.cc.

References builtins, and dependencies.

Referenced by blender::gpu::shader::gpu_shader_dependency_get_builtins().

◆ char_literals_preprocess()

void blender::gpu::GPUSource::char_literals_preprocess ( )

inline

Definition at line 607 of file gpu_shader_dependency.cc.

References CHECK, find_token, hex, blender::StringRefBase::is_empty(), output, processed_source, blender::StringRefBase::size(), SNPRINTF, source, and blender::StringRefBase::substr().

◆ check_no_quotes()

void blender::gpu::GPUSource::check_no_quotes ( )

inline

Some drivers completely forbid quote characters even in unused preprocessor directives. We fix the cases where we can't manually patch in enum_preprocess(). This check ensure none are present in non-patched sources. (see #97545)

Definition at line 217 of file gpu_shader_dependency.cc.

References is_in_comment(), pos, print_error(), and source.

Referenced by GPUSource().

◆ enum_preprocess()

void blender::gpu::GPUSource::enum_preprocess ( )

inline

Transform C,C++ enum declaration into GLSL compatible defines and constants:

enum eMyEnum : uint32_t {
  ENUM_1 = 0u,
  ENUM_2 = 1u,
  ENUM_3 = 2u,
};

or

enum eMyEnum {
  ENUM_1 = 0u,
  ENUM_2 = 1u,
  ENUM_3 = 2u,
};

becomes

#define eMyEnum uint

const uint ENUM_1 = 0u, ENUM_2 = 1u, ENUM_3 = 2u;

IMPORTANT: This has some requirements:

Enums needs to have underlying types specified to uint32_t to make them usable in UBO/SSBO.
All values needs to be specified using constant literals to avoid compiler differences.
All values needs to have the 'u' suffix to avoid GLSL compiler errors.

Definition at line 322 of file gpu_shader_dependency.cc.

References CHECK, filename, blender::StringRefBase::find(), find_keyword, find_token, GPU_backend_get_type(), GPU_BACKEND_METAL, output, processed_source, rfind_token, source, and blender::StringRefBase::substr().

◆ find_str()

template<bool check_whole_word = true, bool reversed = false, typename T>

int64_t blender::gpu::GPUSource::find_str	(	const StringRef &	input,
		const T	keyword,
		int64_t	offset = 0 )

inlinestatic

Definition at line 151 of file gpu_shader_dependency.cc.

References ELEM, blender::StringRefBase::find(), is_in_comment(), blender::gpu::reversed(), and blender::StringRefBase::rfind().

◆ init_dependencies()

int blender::gpu::GPUSource::init_dependencies	(	const GPUSourceDictionnary &	dict,
		const GPUFunctionDictionnary &	g_functions )

inline

Definition at line 1009 of file gpu_shader_dependency.cc.

References BLI_assert_unreachable, builtins, dependencies, g_functions, GPUSource(), init_dependencies(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_default(), pos, print_error(), result, and source.

Referenced by init_dependencies().

◆ is_from_material_library()

bool blender::gpu::GPUSource::is_from_material_library ( ) const

inline

Definition at line 1086 of file gpu_shader_dependency.cc.

References filename.

◆ is_in_comment()

bool blender::gpu::GPUSource::is_in_comment	(	const StringRef &	input,
		int64_t	offset )

inlinestatic

Definition at line 144 of file gpu_shader_dependency.cc.

References blender::StringRefBase::rfind().

Referenced by check_no_quotes(), and find_str().

◆ material_functions_parse()

void blender::gpu::GPUSource::material_functions_parse ( GPUFunctionDictionnary * g_functions )

inline

◆ print_error()

void blender::gpu::GPUSource::print_error	(	const StringRef &	input,
		int64_t	offset,
		const StringRef	message )

inline

Definition at line 184 of file gpu_shader_dependency.cc.

References blender::StringRefBase::begin(), blender::StringRefBase::end(), blender::StringRefBase::find(), fullpath, blender::StringRefBase::rfind(), and blender::StringRefBase::substr().

◆ printf_preprocess()

void blender::gpu::GPUSource::printf_preprocess ( GPUPrintFormatMap * format_map )

inline

Preprocess printf statement for correct shader code generation. printf(format, data1, data2) gets replaced by print_data(print_data(print_header(format_hash, 2), data1), data2).

Definition at line 824 of file gpu_shader_dependency.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert_msg, CHECK, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), blender::StringRefBase::find(), find_keyword, find_token, blender::gpu::shader::PrintfFormat::Block::FLOAT, blender::gpu::shader::PrintfFormat::format_blocks, blender::gpu::shader::PrintfFormat::format_str, blender::hash_string(), blender::gpu::shader::PrintfFormat::Block::INT, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), blender::gpu::shader::PrintfFormat::Block::NONE, output, processed_source, rfind_token, blender::Vector< T, InlineBufferCapacity, Allocator >::size(), source, blender::StringRefBase::substr(), and blender::gpu::shader::PrintfFormat::Block::UINT.

◆ quote_preprocess()

void blender::gpu::GPUSource::quote_preprocess ( )

inline

Some drivers completely forbid string characters even in unused preprocessor directives. This fixes the cases we cannot manually patch: Shared headers #includes. (see #97545) TODO(fclem): This could be done during the datatoc step.

Definition at line 238 of file gpu_shader_dependency.cc.

References processed_source, and source.