Blender V5.3
GPU_shader.hh File Reference
#include <atomic>
#include <mutex>
#include <optional>
#include "BLI_span.hh"
#include "BLI_string_ref.hh"
#include "BLI_utility_mixins.hh"
#include "BLI_vector.hh"
#include "GPU_common_types.hh"
#include "GPU_shader_builtin.hh"

Go to the source code of this file.

Classes

struct  blender::ShaderSpecialization
class  blender::gpu::StaticShader
class  blender::gpu::StaticShaderCache< T >

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::gpu
namespace  blender::gpu::shader

Macros

#define GPU_SHADER_FREE_SAFE(shader)

Functions

Free
void blender::GPU_shader_free (gpu::Shader *shader)
Binding
void blender::GPU_shader_bind (gpu::Shader *shader, const gpu::shader::SpecializationConstants *constants_state=nullptr)
void blender::GPU_shader_unbind ()
gpu::Shader * blender::GPU_shader_get_bound ()
Debugging introspection API.
const char * blender::GPU_shader_get_name (gpu::Shader *shader)
Uniform API.
int blender::GPU_shader_get_ubo_binding (gpu::Shader *shader, const char *name)
int blender::GPU_shader_get_ssbo_binding (gpu::Shader *shader, const char *name)
int blender::GPU_shader_get_sampler_binding (gpu::Shader *shader, const char *name)
int blender::GPU_shader_get_tlas_binding (gpu::Shader *shader, const char *name)
int blender::GPU_shader_get_uniform (gpu::Shader *shader, const char *name)
int blender::GPU_shader_get_constant (gpu::Shader *shader, const char *name)
void blender::GPU_shader_uniform_float_ex (gpu::Shader *shader, int location, int length, int array_size, const float *value)
void blender::GPU_shader_uniform_int_ex (gpu::Shader *shader, int location, int length, int array_size, const int *value)
void blender::GPU_shader_uniform_1i (gpu::Shader *sh, const char *name, int value)
void blender::GPU_shader_uniform_1b (gpu::Shader *sh, const char *name, bool value)
void blender::GPU_shader_uniform_1f (gpu::Shader *sh, const char *name, float value)
void blender::GPU_shader_uniform_2f (gpu::Shader *sh, const char *name, float x, float y)
void blender::GPU_shader_uniform_3f (gpu::Shader *sh, const char *name, float x, float y, float z)
void blender::GPU_shader_uniform_4f (gpu::Shader *sh, const char *name, float x, float y, float z, float w)
void blender::GPU_shader_uniform_2fv (gpu::Shader *sh, const char *name, const float data[2])
void blender::GPU_shader_uniform_3fv (gpu::Shader *sh, const char *name, const float data[3])
void blender::GPU_shader_uniform_4fv (gpu::Shader *sh, const char *name, const float data[4])
void blender::GPU_shader_uniform_2iv (gpu::Shader *sh, const char *name, const int data[2])
void blender::GPU_shader_uniform_3iv (gpu::Shader *sh, const char *name, const int data[3])
void blender::GPU_shader_uniform_mat4 (gpu::Shader *sh, const char *name, const float data[4][4])
void blender::GPU_shader_uniform_mat3 (gpu::Shader *sh, const char *name, const float data[3][3])
void blender::GPU_shader_uniform_mat3_as_mat4 (gpu::Shader *sh, const char *name, const float data[3][3])
void blender::GPU_shader_uniform_1f_array (gpu::Shader *sh, const char *name, int len, const float *val)
void blender::GPU_shader_uniform_2fv_array (gpu::Shader *sh, const char *name, int len, const float(*val)[2])
void blender::GPU_shader_uniform_4fv_array (gpu::Shader *sh, const char *name, int len, const float(*val)[4])
Attribute API.

Used to create #GPUVertexFormat from the shader's vertex input layout.

uint blender::GPU_shader_get_attribute_len (const gpu::Shader *shader)
uint blender::GPU_shader_get_ssbo_input_len (const gpu::Shader *shader)
int blender::GPU_shader_get_attribute (const gpu::Shader *shader, const char *name)
bool blender::GPU_shader_get_attribute_info (const gpu::Shader *shader, int attr_location, char r_name[256], int *r_type)
bool blender::GPU_shader_get_ssbo_input_info (const gpu::Shader *shader, int ssbo_location, char r_name[256])

Variables

static constexpr int blender::GPU_MAX_ATTR = 15

Legacy API

All of this section is deprecated and should be ported to use the API described above.

#define GPU_NUM_UNIFORMS   (GPU_UNIFORM_SCENE_LINEAR_XFORM + 1)
enum  blender::GPUUniformBuiltin {
  blender::GPU_UNIFORM_MODEL = 0 , blender::GPU_UNIFORM_VIEW , blender::GPU_UNIFORM_MODELVIEW , blender::GPU_UNIFORM_PROJECTION ,
  blender::GPU_UNIFORM_VIEWPROJECTION , blender::GPU_UNIFORM_MVP , blender::GPU_UNIFORM_MODEL_INV , blender::GPU_UNIFORM_VIEW_INV ,
  blender::GPU_UNIFORM_MODELVIEW_INV , blender::GPU_UNIFORM_PROJECTION_INV , blender::GPU_UNIFORM_VIEWPROJECTION_INV , blender::GPU_UNIFORM_NORMAL ,
  blender::GPU_UNIFORM_CLIPPLANES , blender::GPU_UNIFORM_COLOR , blender::GPU_UNIFORM_BASE_INSTANCE , blender::GPU_UNIFORM_SRGB_TRANSFORM ,
  blender::GPU_UNIFORM_SCENE_LINEAR_XFORM
}
enum  blender::GPUUniformBlockBuiltin {
  blender::GPU_UNIFORM_BLOCK_VIEW = 0 , blender::GPU_UNIFORM_BLOCK_MODEL , blender::GPU_UNIFORM_BLOCK_INFO , blender::GPU_UNIFORM_BLOCK_DRW_VIEW ,
  blender::GPU_UNIFORM_BLOCK_DRW_MODEL , blender::GPU_UNIFORM_BLOCK_DRW_INFOS , blender::GPU_UNIFORM_BLOCK_DRW_CLIPPING , blender::GPU_NUM_UNIFORM_BLOCKS
}
void blender::GPU_shader_warm_cache (gpu::Shader *shader, int limit)
void blender::GPU_shader_set_parent (gpu::Shader *shader, gpu::Shader *parent)
int blender::GPU_shader_get_builtin_uniform (gpu::Shader *shader, int builtin)
void blender::GPU_shader_compile_static ()
void blender::GPU_shader_cache_dir_clear_old ()
int blender::GPU_shader_get_uniform_block (gpu::Shader *shader, const char *name)

Creation

enum class  blender::CompilationPriority { blender::Low , blender::Medium , blender::High }
using blender::AsyncCompilationHandle = int64_t
std::string blender::GPU_shader_preprocess_source (StringRefNull original, gpu::shader::ShaderCreateInfo &info)
gpu::Shader * blender::GPU_shader_create_from_info (const GPUShaderCreateInfo *_info)
gpu::Shader * blender::GPU_shader_create_from_info_python (const GPUShaderCreateInfo *_info)
gpu::Shader * blender::GPU_shader_create_from_info_name (const char *info_name)
const GPUShaderCreateInfo * blender::GPU_shader_create_info_get (const char *info_name)
bool blender::GPU_shader_create_info_check_error (const GPUShaderCreateInfo *_info, char r_error[128])
AsyncCompilationHandle blender::GPU_shader_async_compilation (const GPUShaderCreateInfo *info, CompilationPriority priority=CompilationPriority::High)
bool blender::GPU_shader_async_compilation_is_ready (AsyncCompilationHandle handle)
gpu::Shader * blender::GPU_shader_async_compilation_finalize (AsyncCompilationHandle &handle)
void blender::GPU_shader_async_compilation_cancel (AsyncCompilationHandle &handle)
bool blender::GPU_shader_compiler_has_pending_work ()
void blender::GPU_shader_compiler_wait_for_all ()
void blender::GPU_shader_compiler_pause ()
void blender::GPU_shader_compiler_resume ()

Specialization API.

Used to allow specialization constants. IMPORTANT: All constants must be specified before binding a shader that needs specialization. Otherwise, it will produce undefined behavior.

using blender::AsyncSpecializationHandle = int64_t
const gpu::shader::SpecializationConstants & blender::GPU_shader_get_default_constant_state (gpu::Shader *sh)
AsyncSpecializationHandle blender::GPU_shader_async_specialization (const ShaderSpecialization &specialization, CompilationPriority priority=CompilationPriority::High)
bool blender::GPU_shader_async_specialization_is_ready (AsyncSpecializationHandle &handle)
void blender::GPU_shader_async_specialization_cancel (AsyncSpecializationHandle &handle)

Detailed Description

A #gpu::Shader is a container for backend specific shader program.

Definition in file GPU_shader.hh.

Macro Definition Documentation

◆ GPU_NUM_UNIFORMS

◆ GPU_SHADER_FREE_SAFE