blender::gpu::shader Namespace Reference

Classes
struct	PrintfFormat
struct	ShaderCreateInfo
	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 GPUShader. More...
struct	SpecializationConstant
struct	StageInterfaceInfo

Typedefs
using	CreateInfoDictionnary = Map<StringRef, ShaderCreateInfo *>
using	CreateInfoValueDictionnary = Map<StringRef, ShaderCreateInfo>
using	InterfaceDictionnary = Map<StringRef, StageInterfaceInfo *>

Enumerations
enum class	Type {   FLOAT = 0 , VEC2 , VEC3 , VEC4 ,   MAT3 , MAT4 , UINT , UVEC2 ,   UVEC3 , UVEC4 , INT , IVEC2 ,   IVEC3 , IVEC4 , BOOL , VEC3_101010I2 ,   UCHAR , UCHAR2 , UCHAR3 , UCHAR4 ,   CHAR , CHAR2 , CHAR3 , CHAR4 ,   USHORT , USHORT2 , USHORT3 , USHORT4 ,   SHORT , SHORT2 , SHORT3 , SHORT4 }
enum class	BuiltinBits {   NONE = 0 , BARYCENTRIC_COORD = (1 << 0) , FRAG_COORD = (1 << 2) , FRONT_FACING = (1 << 4) ,   GLOBAL_INVOCATION_ID = (1 << 5) , INSTANCE_ID = (1 << 6) , LAYER = (1 << 7) , LOCAL_INVOCATION_ID = (1 << 8) ,   LOCAL_INVOCATION_INDEX = (1 << 9) , NUM_WORK_GROUP = (1 << 10) , POINT_COORD = (1 << 11) , POINT_SIZE = (1 << 12) ,   PRIMITIVE_ID = (1 << 13) , VERTEX_ID = (1 << 14) , WORK_GROUP_ID = (1 << 15) , WORK_GROUP_SIZE = (1 << 16) ,   VIEWPORT_INDEX = (1 << 17) , TEXTURE_ATOMIC = (1 << 18) , USE_PRINTF = (1 << 28) , USE_DEBUG_DRAW = (1 << 29) ,   USE_DEBUG_PRINT = (1 << 30) }
enum class	DepthWrite { UNCHANGED = 0 , ANY , GREATER , LESS }
enum class	ImageType {   FLOAT_BUFFER = 0 , FLOAT_1D , FLOAT_1D_ARRAY , FLOAT_2D ,   FLOAT_2D_ARRAY , FLOAT_3D , FLOAT_CUBE , FLOAT_CUBE_ARRAY ,   INT_BUFFER , INT_1D , INT_1D_ARRAY , INT_2D ,   INT_2D_ARRAY , INT_3D , INT_CUBE , INT_CUBE_ARRAY ,   UINT_BUFFER , UINT_1D , UINT_1D_ARRAY , UINT_2D ,   UINT_2D_ARRAY , UINT_3D , UINT_CUBE , UINT_CUBE_ARRAY ,   SHADOW_2D , SHADOW_2D_ARRAY , SHADOW_CUBE , SHADOW_CUBE_ARRAY ,   DEPTH_2D , DEPTH_2D_ARRAY , DEPTH_CUBE , DEPTH_CUBE_ARRAY ,   UINT_2D_ATOMIC , UINT_2D_ARRAY_ATOMIC , UINT_3D_ATOMIC , INT_2D_ATOMIC ,   INT_2D_ARRAY_ATOMIC , INT_3D_ATOMIC }
enum class	Qualifier {   NO_RESTRICT = (1 << 0) , READ = (1 << 1) , WRITE = (1 << 2) , READ_WRITE = READ | WRITE ,   QUALIFIER_MAX = (WRITE << 1) - 1 }
enum class	Frequency { BATCH = 0 , PASS , GEOMETRY }
enum class	DualBlend { NONE = 0 , SRC_0 , SRC_1 }
enum class	Interpolation { SMOOTH = 0 , FLAT , NO_PERSPECTIVE }
enum class	PrimitiveIn {   POINTS = 0 , LINES , LINES_ADJACENCY , TRIANGLES ,   TRIANGLES_ADJACENCY }
enum class	PrimitiveOut {   POINTS = 0 , LINE_STRIP , TRIANGLE_STRIP , LINES ,   TRIANGLES }

Functions
BLI_INLINE int	to_component_count (const Type &type)
static Type	to_type (const eGPUType type)
static std::ostream &	operator<< (std::ostream &stream, const Type type)
static std::ostream &	operator<< (std::ostream &stream, const eGPUType type)
	ENUM_OPERATORS (BuiltinBits, BuiltinBits::USE_DEBUG_PRINT)
	ENUM_OPERATORS (Qualifier, Qualifier::QUALIFIER_MAX)
BuiltinBits	gpu_shader_dependency_get_builtins (const StringRefNull source_name)
bool	gpu_shader_dependency_has_printf ()
bool	gpu_shader_dependency_force_gpu_print_injection ()
const PrintfFormat &	gpu_shader_dependency_get_printf_format (uint32_t format_hash)
Vector< const char * >	gpu_shader_dependency_get_resolved_source (const StringRefNull source_name)
StringRefNull	gpu_shader_dependency_get_source (const StringRefNull source_name)
StringRefNull	gpu_shader_dependency_get_filename_from_source_string (const StringRefNull source_string)
	Find the name of the file from which the given string was generated.
Check Backend Support
static bool	is_vulkan_compatible_interface (const StageInterfaceInfo &iface)

Variables
static CreateInfoDictionnary *	g_create_infos = nullptr
static CreateInfoValueDictionnary *	g_create_infos_unfinalized = nullptr
static InterfaceDictionnary *	g_interfaces = nullptr

Typedef Documentation

CreateInfoDictionnary

using blender::gpu::shader::CreateInfoDictionnary = Map<StringRef, ShaderCreateInfo *>

Definition at line 33 of file gpu_shader_create_info.cc.

CreateInfoValueDictionnary

using blender::gpu::shader::CreateInfoValueDictionnary = Map<StringRef, ShaderCreateInfo>

Definition at line 34 of file gpu_shader_create_info.cc.

InterfaceDictionnary

using blender::gpu::shader::InterfaceDictionnary = Map<StringRef, StageInterfaceInfo *>

Definition at line 35 of file gpu_shader_create_info.cc.

Enumeration Type Documentation

BuiltinBits

enum class blender::gpu::shader::BuiltinBits

strong

Enumerator
NONE
BARYCENTRIC_COORD	Allow getting barycentric coordinates inside the fragment shader. Note Emulated on OpenGL.
FRAG_COORD
FRONT_FACING
GLOBAL_INVOCATION_ID
INSTANCE_ID
LAYER	Allow setting the target layer when the output is a layered frame-buffer. Note Emulated through geometry shader on older hardware.
LOCAL_INVOCATION_ID
LOCAL_INVOCATION_INDEX
NUM_WORK_GROUP
POINT_COORD
POINT_SIZE
PRIMITIVE_ID
VERTEX_ID
WORK_GROUP_ID
WORK_GROUP_SIZE
VIEWPORT_INDEX	Allow setting the target viewport when using multi viewport feature. Note Emulated through geometry shader on older hardware.
TEXTURE_ATOMIC
USE_PRINTF
USE_DEBUG_DRAW
USE_DEBUG_PRINT

Definition at line 156 of file gpu_shader_create_info.hh.

DepthWrite

enum class blender::gpu::shader::DepthWrite

strong

Follow convention described in: https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_conservative_depth.txt

Enumerator
UNCHANGED
ANY
GREATER
LESS

Definition at line 201 of file gpu_shader_create_info.hh.

DualBlend

enum class blender::gpu::shader::DualBlend

strong

Dual Source Blending Index.

Enumerator
NONE
SRC_0
SRC_1

Definition at line 282 of file gpu_shader_create_info.hh.

Frequency

enum class blender::gpu::shader::Frequency

strong

Maps to different descriptor sets.

Enumerator
BATCH
PASS
GEOMETRY	Special frequency tag that will automatically source storage buffers from GPUBatch.

Definition at line 274 of file gpu_shader_create_info.hh.

ImageType

enum class blender::gpu::shader::ImageType

strong

Enumerator
FLOAT_BUFFER	Color samplers/image.
FLOAT_1D
FLOAT_1D_ARRAY
FLOAT_2D
FLOAT_2D_ARRAY
FLOAT_3D
FLOAT_CUBE
FLOAT_CUBE_ARRAY
INT_BUFFER
INT_1D
INT_1D_ARRAY
INT_2D
INT_2D_ARRAY
INT_3D
INT_CUBE
INT_CUBE_ARRAY
UINT_BUFFER
UINT_1D
UINT_1D_ARRAY
UINT_2D
UINT_2D_ARRAY
UINT_3D
UINT_CUBE
UINT_CUBE_ARRAY
SHADOW_2D	Depth samplers (not supported as image).
SHADOW_2D_ARRAY
SHADOW_CUBE
SHADOW_CUBE_ARRAY
DEPTH_2D
DEPTH_2D_ARRAY
DEPTH_CUBE
DEPTH_CUBE_ARRAY
UINT_2D_ATOMIC	Atomic texture type wrappers. For OpenGL, these map to the equivalent (U)INT_* types. NOTE: Atomic variants MUST be used if the texture bound to this resource has usage flag: GPU_TEXTURE_USAGE_ATOMIC, even if atomic texture operations are not used in the given shader. The shader source MUST also utilize the correct atomic sampler handle e.g. usampler2DAtomic in conjunction with these types, for passing texture/image resources into functions.
UINT_2D_ARRAY_ATOMIC
UINT_3D_ATOMIC
INT_2D_ATOMIC
INT_2D_ARRAY_ATOMIC
INT_3D_ATOMIC

Definition at line 210 of file gpu_shader_create_info.hh.

Interpolation

enum class blender::gpu::shader::Interpolation

strong

Interpolation qualifiers.

Enumerator
SMOOTH
FLAT
NO_PERSPECTIVE

Definition at line 289 of file gpu_shader_create_info.hh.

PrimitiveIn

enum class blender::gpu::shader::PrimitiveIn

strong

Input layout for geometry shader.

Enumerator
POINTS
LINES
LINES_ADJACENCY
TRIANGLES
TRIANGLES_ADJACENCY

Definition at line 296 of file gpu_shader_create_info.hh.

PrimitiveOut

enum class blender::gpu::shader::PrimitiveOut

strong

Output layout for geometry shader.

Enumerator
POINTS
LINE_STRIP
TRIANGLE_STRIP
LINES
TRIANGLES

Definition at line 305 of file gpu_shader_create_info.hh.

Qualifier

enum class blender::gpu::shader::Qualifier

strong

Enumerator
NO_RESTRICT	Restrict flag is set by default. Unless specified otherwise.
READ
WRITE
READ_WRITE	Shorthand version of combined flags.
QUALIFIER_MAX

Definition at line 262 of file gpu_shader_create_info.hh.

Type

enum class blender::gpu::shader::Type

strong

Enumerator
FLOAT
VEC2
VEC3
VEC4
MAT3
MAT4
UINT
UVEC2
UVEC3
UVEC4
INT
IVEC2
IVEC3
IVEC4
BOOL
VEC3_101010I2
UCHAR
UCHAR2
UCHAR3
UCHAR4
CHAR
CHAR2
CHAR3
CHAR4
USHORT
USHORT2
USHORT3
USHORT4
SHORT
SHORT2
SHORT3
SHORT4

Definition at line 78 of file GPU_common_types.hh.

Function Documentation

ENUM_OPERATORS() [1/2]

blender::gpu::shader::ENUM_OPERATORS	(	BuiltinBits	,
		BuiltinBits::USE_DEBUG_PRINT	)

ENUM_OPERATORS() [2/2]

blender::gpu::shader::ENUM_OPERATORS	(	Qualifier	,
		Qualifier::QUALIFIER_MAX	)

gpu_shader_dependency_force_gpu_print_injection()

bool blender::gpu::shader::gpu_shader_dependency_force_gpu_print_injection

(

)

Referenced by gpu_shader_create_info_init().

gpu_shader_dependency_get_builtins()

BuiltinBits blender::gpu::shader::gpu_shader_dependency_get_builtins

(

const StringRefNull

source_name

)

Referenced by gpu_shader_create_info_init().

gpu_shader_dependency_get_filename_from_source_string()

StringRefNull blender::gpu::shader::gpu_shader_dependency_get_filename_from_source_string

(

const StringRefNull

source_string

)

Find the name of the file from which the given string was generated.

Returns

filename or empty string.

Note

source_string needs to be identical to the one given by gpu_shader_dependency_get_source()

Referenced by blender::gpu::MTLShader::compute_shader_from_glsl(), blender::gpu::MTLShader::fragment_shader_from_glsl(), blender::gpu::GLSource::GLSource(), and blender::gpu::Shader::print_log().

gpu_shader_dependency_get_printf_format()

const PrintfFormat & blender::gpu::shader::gpu_shader_dependency_get_printf_format

(

uint32_t

format_hash

)

Referenced by blender::gpu::printf_end().

gpu_shader_dependency_get_resolved_source()

Vector< const char * > blender::gpu::shader::gpu_shader_dependency_get_resolved_source

(

const StringRefNull

source_name

)

Referenced by GPUCodegen::generate_library().

gpu_shader_dependency_get_source()

StringRefNull blender::gpu::shader::gpu_shader_dependency_get_source

(

const StringRefNull

source_name

)

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

gpu_shader_dependency_has_printf()

bool blender::gpu::shader::gpu_shader_dependency_has_printf

(

)

Referenced by blender::gpu::printf_begin().

is_vulkan_compatible_interface()

static bool blender::gpu::shader::is_vulkan_compatible_interface ( const StageInterfaceInfo & iface )

static

Definition at line 46 of file gpu_shader_create_info.cc.

References FLAT, blender::gpu::shader::StageInterfaceInfo::inouts, blender::gpu::shader::StageInterfaceInfo::instance_name, blender::StringRefBase::is_empty(), blender::gpu::shader::StageInterfaceInfo::name, NO_PERSPECTIVE, and SMOOTH.

Referenced by blender::gpu::shader::ShaderCreateInfo::is_vulkan_compatible().

operator<<() [1/2]

static std::ostream & blender::gpu::shader::operator<< ( std::ostream & stream, const eGPUType type )

inlinestatic

Definition at line 146 of file gpu_shader_create_info.hh.

References GPU_CLOSURE, and to_type().

operator<<() [2/2]

static std::ostream & blender::gpu::shader::operator<< ( std::ostream & stream, const Type type )

inlinestatic

Definition at line 73 of file gpu_shader_create_info.hh.

References BLI_assert, BOOL, CHAR, CHAR2, CHAR3, CHAR4, FLOAT, INT, IVEC2, IVEC3, IVEC4, MAT3, MAT4, SHORT, SHORT2, SHORT3, SHORT4, UCHAR, UCHAR2, UCHAR3, UCHAR4, UINT, USHORT, USHORT2, USHORT3, USHORT4, UVEC2, UVEC3, UVEC4, VEC2, VEC3, VEC3_101010I2, and VEC4.

to_component_count()

BLI_INLINE int blender::gpu::shader::to_component_count

(

const Type &

type

)

Definition at line 120 of file GPU_common_types.hh.

References BLI_assert_unreachable, BOOL, CHAR, CHAR2, CHAR3, CHAR4, FLOAT, INT, IVEC2, IVEC3, IVEC4, MAT3, MAT4, SHORT, SHORT2, SHORT3, SHORT4, UCHAR, UCHAR2, UCHAR3, UCHAR4, UINT, USHORT, USHORT2, USHORT3, USHORT4, UVEC2, UVEC3, UVEC4, VEC2, VEC3, VEC3_101010I2, and VEC4.

Referenced by blender::gpu::GLShader::fragment_interface_declare(), blender::gpu::VKShader::fragment_interface_declare(), and blender::gpu::MSLGeneratorInterface::generate_msl_fragment_tile_input_population().

to_type()

static Type blender::gpu::shader::to_type ( const eGPUType type )

inlinestatic

Definition at line 52 of file gpu_shader_create_info.hh.

References BLI_assert_msg, FLOAT, GPU_FLOAT, GPU_MAT3, GPU_MAT4, GPU_VEC2, GPU_VEC3, GPU_VEC4, MAT3, MAT4, VEC2, VEC3, and VEC4.

Referenced by blender::nodes::materialx::NodeItem::convert(), GPUCodegen::generate_attribs(), blender::nodes::materialx::NodeParser::get_input_default(), blender::nodes::materialx::NodeParser::get_input_default(), blender::nodes::materialx::NodeParser::get_input_link(), blender::nodes::materialx::NodeParser::get_input_link(), blender::nodes::materialx::NodeParser::get_input_value(), blender::nodes::materialx::NodeParser::get_input_value(), blender::nodes::materialx::NodeParser::get_output_default(), blender::nodes::materialx::NodeParser::get_output_default(), blender::nodes::materialx::NodeItem::if_else(), blender::nodes::materialx::NodeItem::mix(), operator<<(), and blender::nodes::materialx::NodeItem::operator==().

Variable Documentation

g_create_infos

CreateInfoDictionnary* blender::gpu::shader::g_create_infos = nullptr

static

Definition at line 37 of file gpu_shader_create_info.cc.

Referenced by gpu_shader_create_info_compile(), gpu_shader_create_info_exit(), gpu_shader_create_info_get(), and gpu_shader_create_info_init().

g_create_infos_unfinalized

CreateInfoValueDictionnary* blender::gpu::shader::g_create_infos_unfinalized = nullptr

static

Definition at line 38 of file gpu_shader_create_info.cc.

Referenced by gpu_shader_create_info_exit(), gpu_shader_create_info_get_unfinalized_copy(), and gpu_shader_create_info_init().

g_interfaces

InterfaceDictionnary* blender::gpu::shader::g_interfaces = nullptr

static

Definition at line 39 of file gpu_shader_create_info.cc.

Referenced by gpu_shader_create_info_exit(), and gpu_shader_create_info_init().