cgv
Loading...
Searching...
No Matches
shader_program.h
1#pragma once
2
3#include <set>
4#include "element_traits.h"
5#include "shader_code.h"
6#include "textured_material.h"
7
8namespace cgv {
9 namespace media {
10 namespace illum {
11 struct surface_material;
12 class light_source;
13 }
14 }
15}
16
17#include "lib_begin.h"
18
19namespace cgv {
20 namespace utils {
21 struct line;
22 }
23 namespace render {
24
27class CGV_API shader_program : public shader_program_base
28{
29protected:
31 static std::map<std::string, std::string> program_file_cache;
32 static std::map<std::string, std::vector<std::string>> files_cache;
33
34 bool show_code_errors : 1;
35 bool linked : 1;
36 bool state_out_of_date : 1;
37 int nr_attached_geometry_shaders : 13;
38
39 std::vector<shader_code*> managed_codes;
40
42 bool attach_files(const context& ctx, const std::vector<std::string>& file_names, const shader_compile_options& options = {});
44 void update_state(const context& ctx);
46 static bool open_program_file(std::string& file_name, bool use_cache, std::string& content, std::vector<cgv::utils::line>& lines, std::string* last_error_ptr = 0);
47public:
48
50 static bool collect_files_from_cache(const std::string& name, std::vector<std::string>& file_names, bool& added_files);
51
53 static bool collect_file(const std::string& file_name, bool use_cache, std::vector<std::string>& file_names);
56 static bool collect_files(const std::string& base_name, bool use_cache, std::vector<std::string>& file_names);
61 static bool collect_dir(const std::string& dir_name, bool recursive, std::vector<std::string>& file_names);
80 static bool collect_program(const std::string& file_name, bool use_cache, std::vector<std::string>& file_names);
82 static unsigned int get_max_nr_geometry_shader_output_vertices(const context& ctx);
85 shader_program(bool _show_code_errors = false);
87 ~shader_program();
89 bool create(const context& ctx);
91 void destruct(const context& ctx);
93 bool attach_code(const context& ctx, const shader_code& code);
95 bool detach_code(const context& ctx, const shader_code& code);
97 bool attach_code(const context& ctx, const std::string& source, ShaderType st);
99 bool attach_file(const context& ctx, const std::string& file_name, ShaderType st = ST_DETECT, const shader_compile_options& options = {});
101 bool attach_files(const context& ctx, const std::string& base_name, const shader_compile_options& options = {});
103 bool attach_dir(const context& ctx, const std::string& dir_name, bool recursive, const shader_compile_options& options = {});
105 bool attach_program(const context& ctx, std::string file_name, bool show_error = false, const shader_compile_options& options = {});
107 static std::vector<shader_compile_options> extract_instances(std::string file_name);
109 bool link(const context& ctx, bool show_error = false);
111 bool is_linked() const;
113 bool build_files(const context& ctx, const std::string& base_name, bool show_error = false);
115 bool build_dir(const context& ctx, const std::string& dir_name, bool recursive = false, bool show_error = false);
117 bool build_program(const context& ctx, const std::string& file_name, bool show_error = false);
119 bool build_files(const context& ctx, const std::string& base_name, const shader_compile_options& options, bool show_error = false);
121 bool build_dir(const context& ctx, const std::string& dir_name, const shader_compile_options& options, bool recursive = false, bool show_error = false);
123 bool build_program(const context& ctx, const std::string& file_name, const shader_compile_options& options, bool show_error = false);
125 void set_geometry_shader_info(PrimitiveType input_type, PrimitiveType output_type, int max_output_count = 0);
127 bool enable(context& ctx);
129 bool disable(context& ctx);
131 bool is_enabled() const { return shader_program_base::is_enabled; }
133 const std::map<std::string, int>& get_uniform_locations() const;
135 int get_uniform_location(const context& ctx, const std::string& name) const;
137 bool set_material_uniform(const context& ctx, const std::string& name, const cgv::media::illum::surface_material& material, bool generate_error = false);
139 bool set_textured_material_uniform(const context& ctx, const std::string& name, const textured_material& material, bool generate_error = false);
141 bool set_light_uniform(const context& ctx, const std::string& name, const cgv::media::illum::light_source& light, bool generate_error = false);
145 template <typename T>
146 bool set_uniform(const context& ctx, const std::string& name, const T& value, bool generate_error = false) {
147 int loc = get_uniform_location(ctx, name);
148 if (loc == -1) {
149 if (generate_error)
150 ctx.error(std::string("shader_program::set_uniform() uniform <") + name + "> not found", this);
151 return false;
152 }
153 return ctx.set_uniform_void(*this, loc, element_descriptor_traits<T>::get_type_descriptor(value), element_descriptor_traits<T>::get_address(value));
154 }
156 template <typename T>
157 bool set_uniform_array(const context& ctx, const std::string& name, const T& array) {
158 int loc = get_uniform_location(ctx, name);
159 if (loc == -1) {
160 ctx.error(std::string("shader_program::set_uniform_array() uniform <") + name + "> not found", this);
161 return false;
162 }
163 return ctx.set_uniform_array_void(*this, loc, array_descriptor_traits<T>::get_type_descriptor(array), array_descriptor_traits<T>::get_address(array), array_descriptor_traits<T>::get_nr_elements(array));
164 }
166 template <typename T>
167 bool set_uniform_array(const context& ctx, const std::string& name, const T* array, size_t nr_elements, bool generate_error = false) {
168 int loc = get_uniform_location(ctx, name);
169 if (loc == -1) {
170 if (generate_error)
171 ctx.error(std::string("shader_program::set_uniform_array() uniform <") + name + "> not found", this);
172 return false;
173 }
174 return ctx.set_uniform_array_void(*this, loc, type_descriptor(element_descriptor_traits<T>::get_type_descriptor(array[0]), true), array, nr_elements);
175 }
179 template <typename T>
180 bool set_uniform(const context& ctx, int loc, const T& value) {
181 return ctx.set_uniform_void(*this, loc, element_descriptor_traits<T>::get_type_descriptor(value), element_descriptor_traits<T>::get_address(value));
182 }
184 template <typename T>
185 bool set_uniform_array(const context& ctx, int loc, const T& array) {
186 return ctx.set_uniform_array_void(*this, loc, array_descriptor_traits<T>::get_type_descriptor(array), array_descriptor_traits<T>::get_address(array), array_descriptor_traits<T>::get_nr_elements(array));
187 }
189 template <typename T>
190 bool set_uniform_array(const context& ctx, int loc, const T* array, size_t nr_elements) {
191 return ctx.set_uniform_array_void(*this, loc, type_descriptor(element_descriptor_traits<T>::get_type_descriptor(array), true), array, nr_elements);
192 }
196 bool set_uniform(const context& ctx, int loc, type_descriptor value_type, const void* value_ptr) {
197 return ctx.set_uniform_void(*this, loc, value_type, value_ptr);
198 }
200 int get_attribute_location(const context& ctx, const std::string& name) const;
202 template <typename T>
203 bool set_attribute(const context& ctx, const std::string& name, const T& value) {
204 int loc = ctx.get_attribute_location(*this, name);
205 if (loc == -1) {
206 ctx.error(std::string("shader_program::set_attribute() attribute <") + name + "> not found", this);
207 return false;
208 }
209 return ctx.set_attribute_void(*this, loc, element_descriptor_traits<T>::get_type_descriptor(value), element_descriptor_traits<T>::get_address(value));
210 }
212 template <typename T>
213 bool set_attribute(const context& ctx, int loc, const T& value) {
214 if (loc == -1) {
215 ctx.error("shader_program::set_attribute() called with loc=-1", this);
216 return false;
217 }
218 return ctx.set_attribute_void(*this, loc, element_descriptor_traits<T>::get_type_descriptor(value), element_descriptor_traits<T>::get_address(value));
219 }
220};
221
222 }
223}
224
225#include <cgv/config/lib_end.h>
cgv::media::illum::light_source
>simple class to hold the properties of a light source
Definition light_source.h:17
cgv::render::context
base class for all drawables, which is independent of the used rendering API.
Definition context.h:627
cgv::render::context::error
virtual void error(const std::string &message, const render_component *rc=0) const
error handling
Definition context.cxx:219
cgv::render::shader_code
a shader code object holds a code fragment of a geometry vertex or fragment shader and can be added t...
Definition shader_code.h:250
cgv::render::shader_compile_options
Stores preprocessor options used for conditionally compiling shader programs.
Definition shader_code.h:73
cgv::render::shader_program_base
base interface for shader programs
Definition context.h:364
cgv::render::shader_program
a shader program combines several shader code fragments to a complete definition of the shading pipel...
Definition shader_program.h:28
cgv::render::shader_program::set_uniform_array
bool set_uniform_array(const context &ctx, const std::string &name, const T *array, size_t nr_elements, bool generate_error=false)
set uniform array from an array with nr_elements elements of type T pointed to by array
Definition shader_program.h:167
cgv::render::shader_program::program_file_cache
static std::map< std::string, std::string > program_file_cache
maps used to cache program file contents and valid file names indexed by their respective file name
Definition shader_program.h:31
cgv::render::shader_program::set_uniform
bool set_uniform(const context &ctx, const std::string &name, const T &value, bool generate_error=false)
Set the value of a uniform by name, where the type can be any of int, unsigned, float,...
Definition shader_program.h:146
cgv::render::shader_program::set_uniform_array
bool set_uniform_array(const context &ctx, const std::string &name, const T &array)
set uniform array from array array where number elements can be derived from array through array_desc...
Definition shader_program.h:157
cgv::render::shader_program::set_uniform
bool set_uniform(const context &ctx, int loc, const T &value)
Set the value of a uniform by location, where the type can be any of int, unsigned,...
Definition shader_program.h:180
cgv::render::shader_program::set_attribute
bool set_attribute(const context &ctx, const std::string &name, const T &value)
set constant default value of a vertex attribute by attribute name, if name does not specify an attri...
Definition shader_program.h:203
cgv::render::shader_program::set_uniform_array
bool set_uniform_array(const context &ctx, int loc, const T &array)
set uniform array from array array where number elements can be derived from array through array_desc...
Definition shader_program.h:185
cgv::render::shader_program::is_enabled
bool is_enabled() const
check whether program is currently enabled
Definition shader_program.h:131
cgv::render::shader_program::set_attribute
bool set_attribute(const context &ctx, int loc, const T &value)
set constant default value of a vertex attribute by location index
Definition shader_program.h:213
cgv::render::shader_program::set_uniform
bool set_uniform(const context &ctx, int loc, type_descriptor value_type, const void *value_ptr)
Set the value of a uniform by location, where the value is defined by a type descriptor and address.
Definition shader_program.h:196
cgv::render::shader_program::set_uniform_array
bool set_uniform_array(const context &ctx, int loc, const T *array, size_t nr_elements)
set uniform array from an array with nr_elements elements of type T pointed to by array
Definition shader_program.h:190
cgv::render::textured_material
class that extends obj_material with the management of textures
Definition textured_material.h:13
cgv::render::ShaderType
ShaderType
different shader types
Definition context.h:496
cgv
the cgv namespace
Definition print.h:11
cgv::media::illum::surface_material
Stores properties of a surface material.
Definition surface_material.h:25
cgv::render::array_descriptor_traits
Definition element_traits.h:74
cgv::render::element_descriptor_traits
Definition element_traits.h:18
cgv::render::type_descriptor
compact type description of data that can be sent to the context; convertible to int
Definition context.h:56