cgv
Loading...
Searching...
No Matches
context.h
1#pragma once
2
3// make sure this is the first thing the compiler sees, while preventing warnings if
4// it happened to already be defined by something else including this header
5#ifndef _USE_MATH_DEFINES
6 #define _USE_MATH_DEFINES 1
7#endif
8#include <cgv/defines/deprecated.h>
9#include <cgv/data/data_view.h>
10#include <cgv/media/font/font.h>
11#include <cgv/media/axis_aligned_box.h>
12#include <cgv/media/illum/phong_material.h>
13#include <cgv/media/illum/textured_surface_material.h>
14#include <cgv/media/illum/light_source.h>
15#include <cgv/signal/callback_stream.h>
16#include <cgv/math/vec.h>
17#include <cgv/math/inv.h>
18#include <stack>
19#include <vector>
20#include <string>
21
22#include "lib_begin.h"
23
24namespace cgv {
25 namespace render {
26
27class CGV_API drawable;
28class CGV_API textured_material;
29
32 GPU_VENDOR_UNKNOWN,
33 GPU_VENDOR_AMD,
34 GPU_VENDOR_INTEL,
35 GPU_VENDOR_NVIDIA
36};
37
40 ET_VALUE,
41 ET_VECTOR,
42 ET_MATRIX
43};
44
47{
48 cgv::type::info::TypeId coordinate_type : 8;
49 ElementType element_type : 4;
50 unsigned nr_rows : 4;
51 unsigned nr_columns : 4;
52 bool is_row_major : 1;
53 bool is_array : 1;
54 bool normalize : 1;
56 type_descriptor(int td = 0) { *reinterpret_cast<int*>(this) = td; }
58 type_descriptor(cgv::type::info::TypeId _coordinate_type, bool _normalize = false) : coordinate_type(_coordinate_type), element_type(ET_VALUE), nr_rows(1), nr_columns(1), is_row_major(false), is_array(false), normalize(_normalize) {}
60 type_descriptor(cgv::type::info::TypeId _coordinate_type, unsigned _nr_entries, bool _normalize = false) : coordinate_type(_coordinate_type), element_type(ET_VECTOR), nr_rows(_nr_entries), nr_columns(1), is_row_major(false), is_array(false), normalize(_normalize) {}
62 type_descriptor(cgv::type::info::TypeId _coordinate_type, unsigned _nr_rows, unsigned _nr_cols, bool _is_row_major, bool _normalize = false) : coordinate_type(_coordinate_type), element_type(ET_MATRIX), nr_rows(_nr_rows), nr_columns(_nr_cols), is_row_major(_is_row_major), is_array(false), normalize(_normalize) {}
64 type_descriptor(const type_descriptor& td, bool _is_array) : coordinate_type(td.coordinate_type), element_type(td.element_type), nr_rows(td.nr_rows), nr_columns(td.nr_columns), is_row_major(td.is_row_major), normalize(td.normalize), is_array(_is_array) {}
66 operator int() const { return *reinterpret_cast<const int*>(this); }
67};
68
71 RA_OPENGL,
72 RA_DIRECTX
73};
74
75
88
90extern CGV_API std::string get_render_pass_name(RenderPass rp);
91
126
129 MS_NONE,
130 MS_FRONT,
131 MS_BACK,
132 MS_FRONT_AND_BACK
133};
134
137 IM_OFF,
138 IM_ONE_SIDED,
139 IM_TWO_SIDED
140};
141
144 CM_OFF,
145 CM_BACKFACE,
146 CM_FRONTFACE
147};
148
151 BF_ZERO,
152 BF_ONE,
153 BF_SRC_COLOR,
154 BF_ONE_MINUS_SRC_COLOR,
155 BF_DST_COLOR,
156 BF_ONE_MINUS_DST_COLOR,
157 BF_SRC_ALPHA,
158 BF_ONE_MINUS_SRC_ALPHA,
159 BF_DST_ALPHA,
160 BF_ONE_MINUS_DST_ALPHA,
161 BF_CONSTANT_COLOR,
162 BF_ONE_MINUS_CONSTANT_COLOR,
163 BF_CONSTANT_ALPHA,
164 BF_ONE_MINUS_CONSTANT_ALPHA,
165 BF_SRC_ALPHA_SATURATE,
166 BF_SRC1_COLOR,
167 BF_ONE_MINUS_SRC1_COLOR,
168 BF_SRC1_ALPHA,
169 BF_ONE_MINUS_SRC1_ALPHA
170};
171
174 TW_REPEAT = 0,
175 TW_CLAMP = 1,
176 TW_CLAMP_TO_EDGE = 2,
177 TW_CLAMP_TO_BORDER = 3,
178 TW_MIRROR_CLAMP = 4,
179 TW_MIRROR_CLAMP_TO_EDGE = 5,
180 TW_MIRROR_CLAMP_TO_BORDER = 6,
181 TW_MIRRORED_REPEAT = 7,
182 TW_LAST
183};
184
186extern CGV_API std::string to_string(TextureWrap wrap);
187
190 TF_NEAREST = 0,
191 TF_LINEAR = 1,
192 TF_NEAREST_MIPMAP_NEAREST = 2,
193 TF_LINEAR_MIPMAP_NEAREST = 3,
194 TF_NEAREST_MIPMAP_LINEAR = 4,
195 TF_LINEAR_MIPMAP_LINEAR = 5,
196 TF_ANISOTROP = 6,
197 TF_LAST
198};
199
202 TT_UNDEF,
203 TT_1D = 1,
204 TT_2D,
205 TT_3D,
206 TT_1D_ARRAY,
207 TT_2D_ARRAY,
208 TT_CUBEMAP,
209 TT_MULTISAMPLE_2D,
210 TT_MULTISAMPLE_2D_ARRAY,
211 TT_BUFFER
212};
213
216 TCS_PLUS_X,
217 TCS_MINUS_X,
218 TCS_PLUS_Y,
219 TCS_MINUS_Y,
220 TCS_PLUS_Z,
221 TCS_MINUS_Z
222};
223
226 PT_UNDEF,
227 PT_POINTS,
228 PT_LINES,
229 PT_LINES_ADJACENCY,
230 PT_LINE_STRIP,
231 PT_LINE_STRIP_ADJACENCY,
232 PT_LINE_LOOP,
233 PT_TRIANGLES,
234 PT_TRIANGLES_ADJACENCY,
235 PT_TRIANGLE_STRIP,
236 PT_TRIANGLE_STRIP_ADJACENCY,
237 PT_TRIANGLE_FAN,
238 PT_QUADS,
239 PT_QUAD_STRIP,
240 PT_POLYGON,
241 PT_PATCHES,
242 PT_LAST
243};
244
251
254{
255 CF_LEQUAL,
256 CF_GEQUAL,
257 CF_LESS,
258 CF_GREATER,
259 CF_EQUAL,
260 CF_NOTEQUAL,
261 CF_ALWAYS,
262 CF_NEVER
263};
264
267 AT_READ_ONLY,
268 AT_WRITE_ONLY,
269 AT_READ_WRITE
270};
271
284
286extern CGV_API std::string to_string(TextureFilter filter_type);
287
289extern CGV_API std::string to_string(PrimitiveType pt);
290
292extern CGV_API std::string to_string(TextureType tt);
293
295extern CGV_API std::string to_string(TextureCubeSides tcs);
296
297class CGV_API context;
298
300class CGV_API render_component
301{
302public:
303 void* handle;
304 void* internal_format;
305 void* user_data;
309 mutable std::string last_error;
313 virtual bool is_created() const;
316 void put_id_void(void* ptr) const;
318 template <typename T>
319 void put_id(T& id) const { put_id_void(&id); }
320};
321
324{
325public:
326 unsigned nr_multi_samples = 0;
328};
329
331class CGV_API texture_base : public render_component
332{
333public:
334 TextureFilter mag_filter;
335 TextureFilter min_filter;
336 TextureWrap wrap_s;
337 TextureWrap wrap_t;
338 TextureWrap wrap_r;
339 float anisotropy;
340 float priority;
341 float border_color[4];
342 CompareFunction compare_function;
343 bool use_compare_function;
344 TextureType tt;
345 bool have_mipmaps;
346 unsigned nr_multi_samples = 5;
347 bool fixed_sample_locations = true;
349 texture_base(TextureType _tt = TT_UNDEF);
350};
351
352
355{
356protected:
357 bool is_enabled;
358 friend class context;
359
360 bool auto_detect_uniforms;
361 bool auto_detect_vertex_attributes;
362
363 // uniforms
364 bool uses_view;
365 bool uses_material;
366 bool uses_lights;
367 bool uses_gamma;
368
369 // vertex attribute names
370 int position_index;
371 int color_index;
372 bool context_sets_color;
373 int normal_index;
374 int texcoord_index;
375
376public:
377 PrimitiveType geometry_shader_input_type;
378 PrimitiveType geometry_shader_output_type;
379 int geometry_shader_output_count;
382 // configure program
383 void specify_standard_uniforms(bool view, bool material, bool lights, bool gamma);
384 void specify_standard_vertex_attribute_names(context& ctx, bool color = true, bool normal = true, bool texcoord = true);
385 void specify_vertex_attribute_names(context& ctx, const std::string& position, const std::string& color = "", const std::string& normal = "", const std::string& texcoord = "");
386 // uniforms
387 bool does_use_view() const { return uses_view; }
388 bool does_use_material() const { return uses_material; }
389 bool does_use_lights() const { return uses_lights; }
390 bool does_use_gamma() const { return uses_gamma; }
391
392 // vertex attribute names
393 void allow_context_to_set_color(bool allow);
394 int get_position_index() const { return position_index; }
395 int get_color_index() const { return color_index; }
396 bool does_context_set_color() const { return context_sets_color; }
397 int get_normal_index() const { return normal_index; }
398 int get_texcoord_index() const { return texcoord_index; }
399};
400
403{
404protected:
405 bool is_enabled;
406 friend class context;
407public:
410};
411
412
425
447
459
468
471{
472protected:
473 friend class context;
474 bool is_enabled;
475 std::vector<int> enabled_color_attachments;
476 bool depth_attached;
477 bool attached[16];
478 int width, height;
479public:
482};
483
485enum ShaderType { ST_DETECT, ST_COMPUTE, ST_VERTEX, ST_TESS_CONTROL, ST_TESS_EVALUATION, ST_GEOMETRY, ST_FRAGMENT };
486
489 FB_0 = 0,
490 FB_1 = 1,
491 FB_2 = 2,
492 FB_3 = 3,
493 FB_4 = 4,
494 FB_5 = 5,
495 FB_6 = 6,
496 FB_7 = 7,
497 FB_BACK = 128,
498 FB_FRONT = 129,
499 FB_LEFT = 512,
500 FB_RIGHT = 1024,
501 FB_BACK_LEFT = FB_BACK+FB_LEFT,
502 FB_BACK_RIGHT = FB_BACK+FB_RIGHT,
503 FB_FRONT_LEFT = FB_FRONT+FB_LEFT,
504 FB_FRONT_RIGHT = FB_FRONT+FB_RIGHT
505};
506
509 MAX_NR_GEOMETRY_SHADER_OUTPUT_VERTICES
510};
511
512// forward declaration of all render components
513class CGV_API texture;
514class CGV_API render_buffer;
515class CGV_API frame_buffer;
516class CGV_API shader_code;
517class CGV_API shader_program;
518
519// declare some colors by name
520extern CGV_API float black[4], white[4], gray[4], green[4], brown[4], dark_red[4];
521extern CGV_API float cyan[4], yellow[4], red[4], blue[4];
522
569
572
574struct CGV_API render_config : public cgv::base::base, public context_config
575{
585
595
599 std::string get_type_name() const;
601 bool self_reflect(cgv::reflect::reflection_handler& srh);
602};
603
606
608extern CGV_API render_config_ptr get_render_config();
609
618
620class CGV_API context : public context_config
621{
622protected:
623 // store the GPU vendor id
624 GPUVendorID gpu_vendor;
625public:
626 friend class CGV_API attribute_array_manager;
627 friend class CGV_API render_component;
628 friend class CGV_API texture;
629 friend class CGV_API render_buffer;
630 friend class CGV_API frame_buffer;
631 friend class CGV_API shader_code;
632 friend class CGV_API shader_program;
633 friend class CGV_API attribute_array_binding;
634 friend class CGV_API vertex_buffer;
635
639 bool enabled = false;
641 CompareFunction test_func = CF_LESS;
642 };
643
645 struct BlendState {
647 bool enabled = false;
649 BlendFunction src_color = BF_ZERO;
651 BlendFunction dst_color = BF_ZERO;
653 BlendFunction src_alpha = BF_ZERO;
655 BlendFunction dst_alpha = BF_ZERO;
656 // TODO: Add blend equation?
657 };
658
660 struct BufferMask {
662 bool depth_flag = true;
664 bool red_flag = true;
666 bool green_flag = true;
668 bool blue_flag = true;
670 bool alpha_flag = true;
671 };
672protected:
673 friend class shader_program_base;
674
699
701 std::stack<vec4> bg_color_stack;
703 std::stack<float> bg_depth_stack;
705 std::stack<int> bg_stencil_stack;
707 std::stack<vec4> bg_accum_color_stack;
708
710 std::stack<DepthTestState> depth_test_state_stack;
712 std::stack<CullingMode> cull_state_stack;
714 std::stack<BlendState> blend_state_stack;
716 std::stack<BufferMask> buffer_mask_stack;
717
719 std::stack<dmat4> modelview_matrix_stack, projection_matrix_stack;
721 std::stack<std::vector<window_transformation>> window_transformation_stack;
723 std::stack<frame_buffer_base*> frame_buffer_stack;
725 std::stack<shader_program_base*> shader_program_stack;
726public:
728 shader_program_base* get_current_program() const;
730 void enable_shader_file_cache();
732 void disable_shader_file_cache();
734 bool is_shader_file_cache_enabled() const;
735protected:
737 std::stack<attribute_array_binding_base*> attribute_array_binding_stack;
740 {
741 bool enabled;
742 vec3 eye_position;
743 vec3 eye_spot_direction;
744 int light_source_index;
745 };
751 std::map<void*, std::pair<cgv::media::illum::light_source, light_source_status> > light_sources;
753 virtual void on_lights_changed();
755 static const unsigned nr_default_light_sources = 2;
757 cgv::media::illum::light_source default_light_source[nr_default_light_sources];
759 void* default_light_source_handles[nr_default_light_sources];
768 {
769 RenderPass pass;
770 RenderPassFlags flags;
771 void* user_data;
772 };
774 std::stack<render_info> render_pass_stack;
782 int cursor_x, cursor_y;
792 int x_offset, y_offset;
798 bool do_screen_shot;
800 virtual void process_text(const std::string& text);
802 virtual void draw_text(const std::string& text);
803
804 virtual int query_integer_constant(ContextIntegerConstant cic) const = 0;
805 virtual void destruct_render_objects();
806 virtual void put_id(void* handle, void* ptr) const = 0;
807
808 virtual cgv::data::component_format texture_find_best_format(const cgv::data::component_format& cf, render_component& rc, const std::vector<cgv::data::data_view>* palettes = 0) const = 0;
809 virtual bool texture_create (texture_base& tb, cgv::data::data_format& df) const = 0;
810 virtual bool texture_create (texture_base& tb, cgv::data::data_format& target_format, const cgv::data::const_data_view& data, int level, int cube_side = -1, int num_array_layers = 0, const std::vector<cgv::data::data_view>* palettes = 0) const = 0;
811 virtual bool texture_create_from_buffer (texture_base& tb, cgv::data::data_format& df, int x, int y, int level) const = 0;
812 virtual bool texture_replace (texture_base& tb, int x, int y, int z_or_cube_side, const cgv::data::const_data_view& data, int level, const std::vector<cgv::data::data_view>* palettes = 0) const = 0;
813 virtual bool texture_replace_from_buffer(texture_base& tb, int x, int y, int z_or_cube_side, int x_buffer, int y_buffer, unsigned int width, unsigned int height, int level) const = 0;
814 virtual bool texture_create_mipmaps (texture_base& tb, cgv::data::data_format& df) const = 0;
815 virtual bool texture_generate_mipmaps (texture_base& tb, unsigned int dim) const = 0;
816 virtual bool texture_destruct (texture_base& tb) const = 0;
817 virtual bool texture_set_state (const texture_base& tb) const = 0;
818 virtual bool texture_enable (texture_base& tb, int tex_unit, unsigned int nr_dims) const = 0;
819 virtual bool texture_disable (texture_base& tb, int tex_unit, unsigned int nr_dims) const = 0;
820 virtual bool texture_bind_as_image (texture_base& tb, int tex_unit, int level, bool bind_array, int layer, AccessType access) const = 0;
821
822 virtual bool render_buffer_create (render_buffer_base& rc, cgv::data::component_format& cf, int& _width, int& _height) const = 0;
823 virtual bool render_buffer_destruct (render_buffer_base& rc) const = 0;
824
825 static void get_buffer_list(frame_buffer_base& fbb, bool& depth_buffer, std::vector<int>& buffers, int offset = 0);
826 virtual bool frame_buffer_create (frame_buffer_base& fbb) const;
827 virtual bool frame_buffer_attach (frame_buffer_base& fbb, const render_buffer_base& rb, bool is_depth, int i) const;
828 virtual bool frame_buffer_attach (frame_buffer_base& fbb, const texture_base& t, bool is_depth, int level, int i, int z) const;
829 virtual bool frame_buffer_is_complete(const frame_buffer_base& fbb) const = 0;
830 virtual bool frame_buffer_enable (frame_buffer_base& fbb);
831 virtual bool frame_buffer_disable (frame_buffer_base& fbb);
832 virtual bool frame_buffer_destruct(frame_buffer_base& fbb) const;
833 virtual void frame_buffer_blit(const frame_buffer_base* src_fbb_ptr, const ivec4& S, frame_buffer_base* dst_fbb_ptr, const ivec4& _D, BufferTypeBits btbs, bool interpolate) const = 0;
834 virtual int frame_buffer_get_max_nr_color_attachments() const = 0;
835 virtual int frame_buffer_get_max_nr_draw_buffers() const = 0;
836
837 virtual bool shader_code_create (render_component& sc, ShaderType st, const std::string& source) const = 0;
838 virtual bool shader_code_compile (render_component& sc) const = 0;
839 virtual void shader_code_destruct(render_component& sc) const = 0;
840
841 virtual bool shader_program_create (shader_program_base& spb) const = 0;
842 virtual void shader_program_attach(shader_program_base& spb, const render_component& sc) const = 0;
843 virtual void shader_program_detach(shader_program_base& spb, const render_component& sc) const = 0;
844 virtual bool shader_program_link(shader_program_base& spb) const;
845 virtual bool shader_program_set_state(shader_program_base& spb) const = 0;
846 virtual bool shader_program_enable (shader_program_base& spb);
847 virtual bool shader_program_disable(shader_program_base& spb);
848 virtual bool shader_program_destruct(shader_program_base& spb) const;
849 virtual int get_uniform_location(const shader_program_base& spb, const std::string& name) const = 0;
850 virtual bool set_uniform_void(shader_program_base& spb, int loc, type_descriptor value_type, const void* value_ptr) const = 0;
851 virtual bool set_uniform_array_void(shader_program_base& spb, int loc, type_descriptor value_type, const void* value_ptr, size_t nr_elements) const = 0;
852 virtual int get_attribute_location(const shader_program_base& spb, const std::string& name) const = 0;
853 virtual bool set_attribute_void(shader_program_base& spb, int loc, type_descriptor value_type, const void* value_ptr) const = 0;
854
855 virtual bool attribute_array_binding_create (attribute_array_binding_base& aab) const = 0;
856 virtual bool attribute_array_binding_destruct(attribute_array_binding_base& aab) const;
857 virtual bool attribute_array_binding_enable (attribute_array_binding_base& aab);
858 virtual bool attribute_array_binding_disable (attribute_array_binding_base& aab);
859 virtual bool set_attribute_array_void(attribute_array_binding_base* aab, int loc, type_descriptor value_type, const vertex_buffer_base* vbb, const void* ptr, size_t nr_elements = 0, unsigned stride_in_bytes = 0) const = 0;
860 virtual bool set_element_array(attribute_array_binding_base* aab, const vertex_buffer_base* vbb) const = 0;
861 virtual bool enable_attribute_array(attribute_array_binding_base* aab, int loc, bool do_enable) const = 0;
862 virtual bool is_attribute_array_enabled(const attribute_array_binding_base* aab, int loc) const = 0;
863
864 virtual bool vertex_buffer_bind(const vertex_buffer_base& vbb, VertexBufferType _type, unsigned _idx = -1) const = 0;
865 virtual bool vertex_buffer_unbind(const vertex_buffer_base& vbb, VertexBufferType _type, unsigned _idx = -1) const = 0;
866 virtual bool vertex_buffer_create(vertex_buffer_base& vbb, const void* array_ptr, size_t size_in_bytes) const = 0;
867 virtual bool vertex_buffer_resize(vertex_buffer_base& vbb, const void* array_ptr, size_t size_in_bytes) const = 0;
868 virtual bool vertex_buffer_replace(vertex_buffer_base& vbb, size_t offset, size_t size_in_bytes, const void* array_ptr) const = 0;
869 virtual bool vertex_buffer_copy(const vertex_buffer_base& src, size_t src_offset, vertex_buffer_base& target, size_t target_offset, size_t size_in_bytes) const = 0;
870 virtual bool vertex_buffer_copy_back(vertex_buffer_base& vbb, size_t offset, size_t size_in_bytes, void* array_ptr) const = 0;
871 virtual bool vertex_buffer_destruct(vertex_buffer_base& vbb) const = 0;
872public:
874 context();
876 virtual ~context();
878 virtual void error(const std::string& message, const render_component* rc = 0) const;
880 virtual GPUVendorID get_gpu_vendor_id() const;
881
885 virtual void init_render_pass();
887 virtual void draw_textual_info();
889 virtual void perform_screen_shot();
891 virtual void finish_render_pass();
893
897 virtual void configure_new_child(cgv::base::base_ptr child);
899 virtual RenderAPI get_render_api() const = 0;
901 unsigned get_render_pass_recursion_depth() const;
903 virtual RenderPass get_render_pass() const;
905 virtual RenderPassFlags get_render_pass_flags() const;
907 virtual void* get_render_pass_user_data() const;
909 virtual RenderPassFlags get_default_render_pass_flags() const;
911 virtual void set_default_render_pass_flags(RenderPassFlags);
913 virtual void render_pass(RenderPass render_pass = RP_MAIN,
914 RenderPassFlags render_pass_flags = RPF_ALL,
915 void* user_data = 0);
917 void set_debug_render_passes(bool _debug);
919 bool get_debug_render_passes() const { return debug_render_passes; }
921 virtual bool in_render_process() const = 0;
923 virtual bool is_created() const = 0;
925 virtual bool is_current() const = 0;
927 virtual bool recreate_context();
929 virtual bool make_current() const = 0;
931 virtual void clear_current() const = 0;
933 virtual void attach_alpha_buffer(bool attach = true) = 0;
935 virtual void attach_depth_buffer(bool attach = true) = 0;
937 virtual void attach_stencil_buffer(bool attach = true) = 0;
939 virtual bool is_stereo_buffer_supported() const = 0;
941 virtual void attach_stereo_buffer(bool attach = true) = 0;
943 virtual void attach_accumulation_buffer(bool attach = true) = 0;
945 virtual void attach_multi_sample_buffer(bool attach = true) = 0;
947
949 virtual unsigned int get_width() const = 0;
951 virtual unsigned int get_height() const = 0;
953 virtual void resize(unsigned int width, unsigned int height) = 0;
954
955
971 virtual bool read_frame_buffer(
972 data::data_view& dv,
973 unsigned int x = 0, unsigned int y = 0,
974 FrameBufferType buffer_type = FB_BACK,
976 data::ComponentFormat cf = data::CF_RGB,
977 int w = -1, int h = -1) = 0;
981 bool write_frame_buffer_to_image(
982 const std::string& file_name,
983 data::ComponentFormat cf = data::CF_RGB,
984 FrameBufferType buffer_type = FB_BACK,
985 unsigned int x = 0, unsigned int y = 0,
986 int w = -1, int h = -1,
987 float depth_offset = 0.9f, float depth_scale = 10.0f);
988
990 void push_bg_color();
992 void pop_bg_color();
994 virtual void set_bg_color(vec4 rgba);
996 void set_bg_color(float r, float g, float b, float a);
998 vec4 get_bg_color() const;
1000 void put_bg_color(float* rgba) const;
1002 void set_bg_alpha(float a);
1004 float get_bg_alpha() const;
1006 void set_bg_clr_idx(unsigned int idx);
1008 unsigned int get_bg_clr_idx() const;
1009
1011 void push_bg_depth();
1013 void pop_bg_depth();
1015 virtual void set_bg_depth(float d);
1017 float get_bg_depth() const;
1018
1020 void push_bg_stencil();
1022 void pop_bg_stencil();
1024 virtual void set_bg_stencil(int s);
1026 int get_bg_stencil() const;
1027
1029 void push_bg_accum_color();
1031 void pop_bg_accum_color();
1033 virtual void set_bg_accum_color(vec4 rgba);
1035 void set_bg_accum_color(float r, float g, float b, float a);
1037 vec4 get_bg_accum_color() const;
1039 void put_bg_accum_color(float* rgba) const;
1041 void set_bg_accum_alpha(float a);
1043 float get_bg_accum_alpha() const;
1044
1046 virtual void clear_background(bool color_flag, bool depth_flag, bool stencil_flag = false, bool accum_flag = false) = 0;
1047
1049 virtual void post_redraw() = 0;
1051 virtual void force_redraw() = 0;
1053 virtual void announce_external_frame_buffer_change(void*& cgv_fbo_storage) = 0;
1055 virtual void recover_from_external_frame_buffer_change(void* cgv_fbo_storage) = 0;
1056
1060 virtual void enable_font_face(media::font::font_face_ptr font_face, float font_size);
1062 virtual float get_current_font_size() const;
1064 virtual media::font::font_face_ptr get_current_font_face() const;
1066
1069 DEPRECATED("deprecated and ignored.") virtual void enable_phong_shading();
1070 DEPRECATED("deprecated and ignored.") virtual void disable_phong_shading();
1071 DEPRECATED("deprecated, use set_material instead.") virtual void enable_material(const cgv::media::illum::phong_material& mat = cgv::media::illum::default_material(), MaterialSide ms = MS_FRONT_AND_BACK, float alpha = 1);
1072 DEPRECATED("deprecated and ignored.") virtual void disable_material(const cgv::media::illum::phong_material& mat = cgv::media::illum::default_material());
1073 DEPRECATED("deprecated, use enable_material(textured_surface_material) instead.") virtual void enable_material(const textured_material& mat, MaterialSide ms = MS_FRONT_AND_BACK, float alpha = 1);
1074 //DEPRECATED("deprecated, use disable_material(textured_surface_material) instead.") virtual void disable_material(const textured_material& mat) = 0;
1076 void set_gamma(float _gamma);
1078 virtual void set_gamma3(const vec3& _gamma3);
1080 float get_gamma() const { return (gamma3.x() + gamma3.y() + gamma3.z()) / 3.0f; }
1082 vec3 get_gamma3() const { return gamma3; }
1084 virtual void enable_sRGB_framebuffer(bool do_enable = true);
1086 bool sRGB_framebuffer_enabled() { return sRGB_framebuffer; }
1088 const rgba& get_color() const;
1090 virtual void set_color(const rgba& clr);
1092 virtual void set_color(const rgb& clr, float opacity = 1.0f) { set_color(rgba(clr[0], clr[1], clr[2], opacity)); }
1094 virtual void set_material(const cgv::media::illum::surface_material& mat);
1096 const cgv::media::illum::surface_material* get_current_material() const;
1098 virtual void set_textured_material(const textured_material& mat);
1100 virtual void enable_material(textured_material& mat) = 0;
1102 virtual void disable_material(textured_material& mat) = 0;
1104 void set_current_gamma(shader_program& prog) const;
1106 void set_current_view(shader_program& prog, bool modelview_deps = true, bool projection_deps = true) const;
1108 void set_current_material(shader_program& prog) const;
1110 void set_current_lights(shader_program& prog) const;
1112 vec3 get_light_eye_position(const cgv::media::illum::light_source& light, bool place_now) const;
1114 vec3 get_light_eye_spot_direction(const cgv::media::illum::light_source& light, bool place_now) const;
1116 virtual shader_program& ref_default_shader_program(bool texture_support = false) = 0;
1118 virtual shader_program& ref_surface_shader_program(bool texture_support = false) = 0;
1120 virtual void enumerate_program_uniforms(shader_program& prog, std::vector<std::string>& names, std::vector<int>* locations_ptr = 0, std::vector<int>* sizes_ptr = 0, std::vector<int>* types_ptr = 0, bool show = false) const = 0;
1122 virtual void enumerate_program_attributes(shader_program& prog, std::vector<std::string>& names, std::vector<int>* locations_ptr = 0, std::vector<int>* sizes_ptr = 0, std::vector<int>* types_ptr = 0, bool show = false) const = 0;
1124
1127 DEPRECATED("deprecated, use add_light_source instead.") void* enable_light(const cgv::media::illum::light_source& light) { return add_light_source(light); }
1128 DEPRECATED("deprecated, use enable_light_source instead.") void disable_light(void* handle) { disable_light_source(handle); }
1129 DEPRECATED("deprecated, use get_max_nr_enabled_light_sources instead.") unsigned get_max_nr_lights() const { return get_max_nr_enabled_light_sources(); }
1131 size_t get_nr_light_sources() const;
1133 void* add_light_source(const cgv::media::illum::light_source& light, bool enabled = true, bool place_now = false);
1135 bool remove_light_source(void* handle);
1137 const cgv::media::illum::light_source& get_light_source(void* handle) const;
1139 const light_source_status& get_light_source_status(void* handle) const;
1141 void set_light_source(void* handle, const cgv::media::illum::light_source& light, bool place_now = true);
1143 void place_light_source(void* handle);
1144
1146 virtual unsigned get_max_nr_enabled_light_sources() const;
1148 size_t get_nr_enabled_light_sources() const;
1150 void* get_enabled_light_source_handle(size_t i) const;
1152 bool is_light_source_enabled(void* handle);
1154 bool enable_light_source(void* handle);
1156 bool disable_light_source(void* handle);
1158 size_t get_nr_default_light_sources() const { return nr_default_light_sources; }
1160 const cgv::media::illum::light_source& get_default_light_source(size_t i) const;
1162 void set_default_light_source(size_t i, const cgv::media::illum::light_source& ls);
1164
1174 virtual std::ostream& output_stream();
1176 virtual void set_cursor(int x, int y);
1178 virtual void get_cursor(int& x, int& y) const;
1181 virtual void put_cursor_coords(const vecn& p, int& x, int& y) const;
1187 virtual void set_cursor(const vecn& pos,
1188 const std::string& text = "", TextAlignment ta = TA_BOTTOM_LEFT,
1189 int x_offset=0, int y_offset=0);
1191
1196 const float* vertices, const float* normals, const float* tex_coords,
1197 const int* vertex_indices, const int* normal_indices, const int* tex_coord_indices,
1198 int nr_faces, int face_degree, bool flip_normals = false) const = 0;
1201 const float* vertices, const float* normals, const float* tex_coords,
1202 const int* vertex_indices, const int* normal_indices, const int* tex_coord_indices,
1203 int nr_faces, int face_degree, bool is_fan, bool flip_normals = false) const = 0;
1205 virtual void draw_faces(
1206 const float* vertices, const float* normals, const float* tex_coords,
1207 const int* vertex_indices, const int* normal_indices, const int* tex_coord_indices,
1208 int nr_faces, int face_degree, bool flip_normals = false) const = 0;
1210 virtual void draw_strip_or_fan(
1211 const float* vertices, const float* normals, const float* tex_coords,
1212 const int* vertex_indices, const int* normal_indices, const int* tex_coord_indices,
1213 int nr_faces, int face_degree, bool is_fan, bool flip_normals = false) const = 0;
1214
1216 void tesselate_unit_square(bool flip_normals = false, bool edges = false);
1218 void tesselate_unit_cube(bool flip_normals = false, bool edges = false);
1220 virtual void tesselate_box(const cgv::media::axis_aligned_box<double, 3>& B, bool flip_normals, bool edges = false) const;
1222 void tesselate_unit_prism(bool flip_normals = false, bool edges = false);
1224 void tesselate_unit_disk(int resolution = 25, bool flip_normals = false, bool edges = false);
1226 void tesselate_unit_cone(int resolution = 25, bool flip_normals = false, bool edges = false);
1228 void tesselate_unit_cylinder(int resolution = 25, bool flip_normals = false, bool edges = false);
1230 void tesselate_unit_sphere(int resolution = 25, bool flip_normals = false, bool edges = false);
1232 void tesselate_unit_tetrahedron(bool flip_normals = false, bool edges = false);
1234 void tesselate_unit_octahedron(bool flip_normals = false, bool edges = false);
1236 void tesselate_unit_dodecahedron(bool flip_normals = false, bool edges = false);
1238 void tesselate_unit_icosahedron(bool flip_normals = false, bool edges = false);
1240 void tesselate_unit_torus(float minor_radius = 0.2f, int resolution = 25, bool flip_normals = false, bool edges = false);
1242
1249 virtual void tesselate_arrow(double length = 1, double aspect = 0.1, double rel_tip_radius = 2.0, double tip_aspect = 0.3, int res = 25, bool edges = false);
1251 virtual void tesselate_arrow(const dvec3& start, const dvec3& end, double aspect = 0.1f, double rel_tip_radius = 2.0f, double tip_aspect = 0.3f, int res = 25, bool edges = false);
1253
1256 virtual void draw_light_source(const cgv::media::illum::light_source& l, float intensity_scale, float light_scale);
1258
1261
1264 void push_depth_test_state();
1266 void pop_depth_test_state();
1268 DepthTestState get_depth_test_state() const;
1270 virtual void set_depth_test_state(DepthTestState state);
1272 virtual void set_depth_func(CompareFunction func);
1274 virtual void enable_depth_test();
1276 virtual void disable_depth_test();
1277
1280 void push_cull_state();
1282 void pop_cull_state();
1284 CullingMode get_cull_state() const;
1286 virtual void set_cull_state(CullingMode culling_mode);
1287
1290 void push_blend_state();
1292 void pop_blend_state();
1294 BlendState get_blend_state() const;
1296 virtual void set_blend_state(BlendState state);
1298 virtual void set_blend_func(BlendFunction src_factor, BlendFunction dst_factor);
1300 virtual void set_blend_func_separate(BlendFunction src_color_factor, BlendFunction dst_color_factor, BlendFunction src_alpha_factor, BlendFunction dst_alpha_factor);
1302 void set_blend_func_front_to_back();
1304 void set_blend_func_back_to_front();
1306 virtual void enable_blending();
1308 virtual void disable_blending();
1309
1312 void push_buffer_mask();
1314 void pop_buffer_mask();
1316 BufferMask get_buffer_mask() const;
1318 virtual void set_buffer_mask(BufferMask mask);
1320 bool get_depth_mask() const;
1322 virtual void set_depth_mask(bool flag);
1324 bvec4 get_color_mask() const;
1326 virtual void set_color_mask(bvec4 flags);
1327
1329
1332 DEPRECATED("deprecated: use get_modelview_matrix() instead.") dmatn get_V() const { return dmatn(4,4,&get_modelview_matrix()(0,0)); }
1333 DEPRECATED("deprecated: use set_modelview_matrix() instead.") void set_V(const dmatn& V) const { const_cast<context*>(this)->set_modelview_matrix(dmat4(4,4,&V(0,0))); }
1334 DEPRECATED("deprecated: use push_modelview_matrix() instead.") void push_V() { push_modelview_matrix(); }
1335 DEPRECATED("deprecated: use pop_modelview_matrix() instead.") void pop_V() { pop_modelview_matrix(); }
1336 DEPRECATED("deprecated: use get_projection_matrix() instead.") dmatn get_P() const { return dmatn(4, 4, &get_projection_matrix()(0, 0)); }
1337 DEPRECATED("deprecated: use set_projection_matrix() instead.") void set_P(const dmatn& P) const { const_cast<context*>(this)->set_projection_matrix(dmat4(4,4,&P(0, 0))); }
1338 DEPRECATED("deprecated: use push_projection_matrix() instead.") void push_P() { push_projection_matrix(); }
1339 DEPRECATED("deprecated: use pop_projection_matrix() instead.") void pop_P() { pop_projection_matrix(); }
1340 DEPRECATED("deprecated: use get_device_matrix() instead.") dmatn get_D() const { return dmatn(4, 4, &get_window_matrix()(0, 0)); }
1341 DEPRECATED("deprecated: use get_modelview_projection_device_matrix() instead.") dmatn get_DPV() const { return dmatn(4, 4, &get_modelview_projection_window_matrix()(0, 0)); }
1345 virtual void push_pixel_coords() = 0;
1347 virtual void pop_pixel_coords() = 0;
1349 virtual dmat4 get_modelview_matrix() const = 0;
1351 virtual void set_modelview_matrix(const dmat4& MV);
1353 virtual void mul_modelview_matrix(const dmat4& MV);
1355
1361 void push_modelview_matrix();
1363 void pop_modelview_matrix();
1365 virtual dmat4 get_projection_matrix() const = 0;
1367 virtual void set_projection_matrix(const dmat4& P);
1369 virtual void mul_projection_matrix(const dmat4& P);
1371 void push_projection_matrix();
1373 void pop_projection_matrix();
1375 void push_window_transformation_array();
1377
1379 virtual void pop_window_transformation_array();
1381 virtual void announce_external_viewport_change(ivec4& cgv_viewport_storage) = 0;
1383 virtual void recover_from_external_viewport_change(const ivec4& cgv_viewport_storage) = 0;
1385 virtual unsigned get_max_window_transformation_array_size() const = 0;
1387
1388protected:
1389 bool ensure_window_transformation_index(int& array_index);
1390public:
1392
1402 virtual void set_viewport(const ivec4& viewport, int array_index = -1);
1404
1406 virtual void set_depth_range(const dvec2& depth_range = dvec2(0, 1), int array_index = -1);
1408 const std::vector<window_transformation>& get_window_transformation_array() const;
1410
1415 dmat4 get_window_matrix(unsigned array_index = 0) const;
1417 dmat4 get_modelview_projection_window_matrix(unsigned array_index = 0) const;
1419 virtual double get_window_z(int x_window, int y_window) const = 0;
1421
1423 inline vec3 get_model_point(int x_window, int y_window) const {
1424 return get_model_point(x_window, y_window, get_window_z(x_window, y_window));
1425 }
1427
1429 inline vec3 get_model_point(int x_window, int y_window, double z_window) const {
1430 return get_model_point(x_window, y_window, z_window, get_modelview_projection_window_matrix());
1431 }
1433
1435 inline vec3 get_model_point(int x_window, int y_window, const dmat4& modelview_projection_window_matrix) const {
1436 return get_model_point(x_window, y_window, get_window_z(x_window, y_window), modelview_projection_window_matrix);
1437 }
1439
1441 inline static vec3 get_model_point(int x_window, int y_window, double z_window, const dmat4& modelview_projection_window_matrix) {
1442 return get_model_point(dvec3(x_window+0.5, y_window+0.5, z_window), modelview_projection_window_matrix);
1443 }
1445
1447 inline vec3 get_model_point(const vec3& p_window) const {
1448 return get_model_point(p_window, get_modelview_projection_window_matrix());
1449 }
1451
1453 static vec3 get_model_point(const dvec3& p_window, const dmat4& modelview_projection_window_matrix);
1455 DEPRECATED("use get_window_matrix() instead.") dmat4 get_device_matrix() const { return get_window_matrix(); }
1457 DEPRECATED("use get_modelview_projection_window_matrix() instead.") dmat4 get_modelview_projection_device_matrix() const;
1459 DEPRECATED("use get_window_z()") double get_z_D(int x_D, int y_D) const { return get_window_z(x_D, y_D); }
1461 DEPRECATED("use get_model_point()") vec3 get_point_W(int x_D, int y_D) const { return get_model_point(x_D, y_D); }
1463 DEPRECATED("use get_model_point()") vec3 get_point_W(int x_D, int y_D, const dmat4& MPD) const { return get_model_point(x_D, y_D, MPD); }
1465 DEPRECATED("use get_model_point()") vec3 get_point_W(int x_D, int y_D, double z_D) const { return get_model_point(x_D, y_D, z_D); }
1467 DEPRECATED("use get_model_point()") vec3 get_point_W(int x_D, int y_D, double z_D, const dmat4& MPD) const { return get_model_point(x_D, y_D, z_D, MPD); }
1469 DEPRECATED("use get_model_point()") vec3 get_point_W(const vec3& p_D) const { return get_model_point(p_D); }
1471 DEPRECATED("use get_model_point()") vec3 get_point_W(const vec3& p_D, const dmat4& MPD) const { return get_model_point(p_D, MPD); }
1473};
1474
1479extern CGV_API context* create_context(RenderAPI api = RA_OPENGL,
1480 unsigned int w = 800, unsigned int h = 600,
1481 const std::string& title = "", bool show = false);
1482
1483typedef context* (*context_creation_function_type)(RenderAPI api, unsigned int w, unsigned int h, const std::string& title, bool show);
1484
1486extern CGV_API void register_context_factory(context_creation_function_type);
1487
1489{
1490 context_factory_registration(context_creation_function_type fp);
1491};
1492
1493 }
1494}
1495
1496#include <cgv/config/lib_end.h>
base class for all classes that can be registered with support for dynamic properties (see also secti...
Definition base.h:75
the component format inherits the information of a packing_info and adds information on the component...
The const_data_view has the functionality of the data_view but uses a const pointer and therefore doe...
Definition data_view.h:221
A data_format describes a multidimensional data block of data entries.
Definition data_format.h:17
the data view gives access to a data array of one, two, three or four dimensions.
Definition data_view.h:153
reference counted pointer, which can work together with types that are derived from ref_counted,...
Definition ref_ptr.h:160
matrix of fixed size dimensions
Definition fmat.h:23
T & z()
third element
Definition fvec.h:163
T & y()
second element
Definition fvec.h:159
T & x()
first element
Definition fvec.h:155
A matrix type (full column major storage) The matrix can be loaded directly into OpenGL without need ...
Definition mat.h:208
An axis aligned box, defined by to points: min and max.
>simple class to hold the properties of a light source
simple class to hold the material properties of a phong material
the self reflection handler is passed to the virtual self_reflect() method of cgv::base::base.
base class for attribute_array_bindings
Definition context.h:403
the attribute_array_binding allows to define vertex attributes (i.e.
attribute array manager used to upload arrays to gpu
base class for all drawables, which is independent of the used rendering API.
Definition context.h:621
virtual void announce_external_viewport_change(ivec4 &cgv_viewport_storage)=0
announce an external viewport change performed with rendering API to the cgv framework providing spac...
virtual bool read_frame_buffer(data::data_view &dv, unsigned int x=0, unsigned int y=0, FrameBufferType buffer_type=FB_BACK, cgv::type::info::TypeId type=cgv::type::info::TI_UINT8, data::ComponentFormat cf=data::CF_RGB, int w=-1, int h=-1)=0
read the current frame buffer or a rectangular region of it into the given data view.
vec3 get_model_point(int x_window, int y_window, const dmat4 &modelview_projection_window_matrix) const
compute model space 3D point from the given opengl pixel location (window location) and modelview_pro...
Definition context.h:1435
vec3 gamma3
per color channel gamma value passed to shader programs that have gamma uniform
Definition context.h:698
virtual bool in_render_process() const =0
return whether the context is currently in process of rendering
virtual bool is_created() const =0
return whether the context is created
virtual void draw_edges_of_faces(const float *vertices, const float *normals, const float *tex_coords, const int *vertex_indices, const int *normal_indices, const int *tex_coord_indices, int nr_faces, int face_degree, bool flip_normals=false) const =0
pass geometry of given faces to current shader program and generate draw calls to render lines for th...
virtual void recover_from_external_viewport_change(const ivec4 &cgv_viewport_storage)=0
restore cgv viewport to the state before the external change
RenderPassFlags default_render_flags
default render flags with which the main render pass is initialized
Definition context.h:776
virtual void announce_external_frame_buffer_change(void *&cgv_fbo_storage)=0
announce an external frame buffer change performed with rendering API to the cgv framework providing ...
vec3 get_model_point(int x_window, int y_window) const
compute model space 3D point from the given opengl pixel location (window location)
Definition context.h:1423
std::stack< render_info > render_pass_stack
store the current render pass
Definition context.h:774
virtual void enumerate_program_uniforms(shader_program &prog, std::vector< std::string > &names, std::vector< int > *locations_ptr=0, std::vector< int > *sizes_ptr=0, std::vector< int > *types_ptr=0, bool show=false) const =0
get list of program uniforms
virtual void draw_edges_of_strip_or_fan(const float *vertices, const float *normals, const float *tex_coords, const int *vertex_indices, const int *normal_indices, const int *tex_coord_indices, int nr_faces, int face_degree, bool is_fan, bool flip_normals=false) const =0
pass geometry of given strip or fan to current shader program and generate draw calls to render lines...
float current_font_size
store current font size
Definition context.h:786
bool enable_vsync
whether vsync should be enabled
Definition context.h:692
virtual void disable_material(textured_material &mat)=0
disable a material with textures
virtual void attach_alpha_buffer(bool attach=true)=0
attach or detach (attach=false) an alpha buffer to the current frame buffer if not present
virtual void attach_stencil_buffer(bool attach=true)=0
attach or detach (attach=false) stencil buffer to the current frame buffer if not present
std::stack< BufferMask > buffer_mask_stack
stack of buffer masks
Definition context.h:716
virtual void draw_strip_or_fan(const float *vertices, const float *normals, const float *tex_coords, const int *vertex_indices, const int *normal_indices, const int *tex_coord_indices, int nr_faces, int face_degree, bool is_fan, bool flip_normals=false) const =0
pass geometry of given strip or fan to current shader program and generate draw calls to render trian...
virtual bool is_current() const =0
return whether the context is current
bool auto_set_lights_in_current_shader_program
whether to automatically set lights in current shader program, defaults to true
Definition context.h:680
size_t light_source_handle
counter to construct light source handles
Definition context.h:749
virtual void attach_stereo_buffer(bool attach=true)=0
attach or detach (attach=false) stereo buffer to the current frame buffer if not present
std::stack< shader_program_base * > shader_program_stack
stack of currently enabled shader programs
Definition context.h:725
virtual unsigned int get_width() const =0
return the width of the window
size_t get_nr_default_light_sources() const
return number of default light sources
Definition context.h:1158
virtual void set_color(const rgb &clr, float opacity=1.0f)
set the current color
Definition context.h:1092
virtual shader_program & ref_default_shader_program(bool texture_support=false)=0
return a reference to a shader program used to render without illumination
int current_background
current back ground color index
Definition context.h:780
virtual void clear_background(bool color_flag, bool depth_flag, bool stencil_flag=false, bool accum_flag=false)=0
clear the buffer contents of the flagged buffers to the set background colors
virtual bool is_stereo_buffer_supported() const =0
return whether the graphics card supports stereo buffer mode
virtual void resize(unsigned int width, unsigned int height)=0
resize the context to the given dimensions
virtual unsigned int get_height() const =0
return the height of the window
vec3 get_gamma3() const
query current per color channel gamma
Definition context.h:1082
vec3 get_model_point(const vec3 &p_window) const
compute model space 3D point from the given window space point
Definition context.h:1447
virtual void draw_faces(const float *vertices, const float *normals, const float *tex_coords, const int *vertex_indices, const int *normal_indices, const int *tex_coord_indices, int nr_faces, int face_degree, bool flip_normals=false) const =0
pass geometry of given faces to current shader program and generate draw calls to render triangles
std::stack< dmat4 > modelview_matrix_stack
keep two matrix stacks for model view and projection matrices
Definition context.h:719
bool use_shader_file_cache
whether to use the caching facilities of shader_program and shader_code to store loaded shader file c...
Definition context.h:676
virtual double get_window_z(int x_window, int y_window) const =0
read the window z-coordinate from the depth buffer for the given opengl x- and y-coordinates
int nr_identations
current number of indentations
Definition context.h:794
virtual void clear_current() const =0
clear the current context, typically used in multi-threaded rendering to allow usage of context in se...
bool auto_set_material_in_current_shader_program
whether to automatically set material in current shader program, defaults to true
Definition context.h:682
virtual void recover_from_external_frame_buffer_change(void *cgv_fbo_storage)=0
restore cgv frame buffer to the state before the external change
static vec3 get_model_point(int x_window, int y_window, double z_window, const dmat4 &modelview_projection_window_matrix)
compute model space 3D point from the given opengl pixel location (window location) with the given mo...
Definition context.h:1441
virtual RenderAPI get_render_api() const =0
return the used rendering API
std::stack< float > bg_depth_stack
stack of background depth values
Definition context.h:703
bool support_compatibility_mode
whether to support view and lighting management of compatibility mode, defaults to true
Definition context.h:686
std::stack< attribute_array_binding_base * > attribute_array_binding_stack
stack of currently enabled attribute array binding
Definition context.h:737
std::stack< DepthTestState > depth_test_state_stack
stack of depth test states
Definition context.h:710
std::stack< CullingMode > cull_state_stack
stack of culling mode states
Definition context.h:712
bool phong_shading
whether to use phong shading
Definition context.h:778
virtual void push_pixel_coords()=0
use this to push new modelview and new projection matrices onto the transformation stacks such that x...
virtual void force_redraw()=0
the context will be redrawn right now. This method cannot be called inside the following methods of a...
bool current_material_is_textured
store flag to tell whether current material is textured
Definition context.h:765
rgba current_color
current color value
Definition context.h:694
std::stack< int > bg_stencil_stack
stack of background stencil values
Definition context.h:705
virtual dmat4 get_projection_matrix() const =0
return homogeneous 4x4 projection matrix, which transforms from eye to clip space
int tab_size
size a tabs
Definition context.h:790
std::stack< vec4 > bg_accum_color_stack
stack of background accumulation colors
Definition context.h:707
vec3 get_model_point(int x_window, int y_window, double z_window) const
compute model space 3D point from the given opengl pixel location (window location)
Definition context.h:1429
cgv::media::illum::surface_material default_material
store a default material
Definition context.h:761
bool sRGB_framebuffer_enabled()
check whether sRGB framebuffer is enabled
Definition context.h:1086
virtual unsigned get_max_window_transformation_array_size() const =0
query the maximum number of supported window transformations, which is at least 1
int x_offset
offset in x and y direction where text starts
Definition context.h:792
virtual void attach_depth_buffer(bool attach=true)=0
attach or detach (attach=false) depth buffer to the current frame buffer if not present
std::map< void *, std::pair< cgv::media::illum::light_source, light_source_status > > light_sources
map handle to light source and light source status information
Definition context.h:751
std::stack< std::vector< window_transformation > > window_transformation_stack
keep stack of window transformations
Definition context.h:721
int cursor_x
current cursor location for textual output
Definition context.h:782
virtual bool make_current() const =0
make the current context current if possible
bool draw_in_compatibility_mode
whether to do all drawing in compatibility mode, only possible if support_compatibility_mode is true,...
Definition context.h:688
bool sRGB_framebuffer
whether to use opengl option to support sRGB framebuffer
Definition context.h:696
virtual void enumerate_program_attributes(shader_program &prog, std::vector< std::string > &names, std::vector< int > *locations_ptr=0, std::vector< int > *sizes_ptr=0, std::vector< int > *types_ptr=0, bool show=false) const =0
get list of program attributes
virtual dmat4 get_modelview_matrix() const =0
return homogeneous 4x4 viewing matrix, which transforms from world to eye space
std::stack< frame_buffer_base * > frame_buffer_stack
stack of currently enabled frame buffers
Definition context.h:723
virtual void pop_pixel_coords()=0
pop previously pushed transformation matrices from modelview and projection stacks
bool at_line_begin
store whether we are at the beginning of the line
Definition context.h:796
virtual void enable_material(textured_material &mat)=0
enable a material with textures
bool auto_set_view_in_current_shader_program
whether to automatically set viewing matrixes in current shader program, defaults to true
Definition context.h:678
bool debug_render_passes
whether to debug render passes
Definition context.h:690
std::vector< void * > enabled_light_source_handles
keep track of enabled light source handles
Definition context.h:747
virtual void attach_accumulation_buffer(bool attach=true)=0
attach or detach (attach=false) accumulation buffer to the current frame buffer if not present
virtual void attach_multi_sample_buffer(bool attach=true)=0
attach or detach (attach=false) multi sample buffer to the current frame buffer if not present
virtual shader_program & ref_surface_shader_program(bool texture_support=false)=0
return a reference to the default shader program used to render surfaces
virtual void post_redraw()=0
the context will be redrawn when the system is idle again
bool get_debug_render_passes() const
check whether render passes are debugged
Definition context.h:919
const cgv::media::illum::surface_material * current_material_ptr
store pointer to current material
Definition context.h:763
cgv::media::font::font_face_ptr current_font_face
store current font
Definition context.h:788
cgv::signal::callback_stream out_stream
use a callback stream to write text to the opengl context
Definition context.h:784
std::stack< vec4 > bg_color_stack
stack of background colors
Definition context.h:701
std::stack< BlendState > blend_state_stack
stack of blend states
Definition context.h:714
bool auto_set_gamma_in_current_shader_program
whether to automatically set gamma in current shader program, defaults to true
Definition context.h:684
base interface for framebuffer
Definition context.h:471
this class encapsulate frame buffers that live on the GPU and can be used as destination for the rend...
base interface for a render_buffer
Definition context.h:324
this class encapsulate render buffers that live on the GPU which must support frame buffer objects fo...
base interface for all render components
Definition context.h:301
void put_id(T &id) const
cast the refence to rendering api specific representation of component id to the specified type
Definition context.h:319
const context * ctx_ptr
keep pointer to my context
Definition context.h:307
std::string last_error
a string that contains the last error
Definition context.h:309
a shader code object holds a code fragment of a geometry vertex or fragment shader and can be added t...
Definition shader_code.h:58
base interface for shader programs
Definition context.h:355
a shader program combines several shader code fragments to a complete definition of the shading pipel...
base interface for a texture
Definition context.h:332
the texture class encapsulates all functionality independent of the rendering api.
Definition texture.h:15
class that extends obj_material with the management of textures
base interface for a vertex buffer
Definition context.h:450
VertexBufferType type
buffer type defaults to VBT_VERTICES
Definition context.h:453
VertexBufferUsage usage
usage defaults to VBU_STATIC_DRAW
Definition context.h:455
a vertex buffer is an unstructured memory block on the GPU.
defines a symmetric view with the following quantities:
Definition view.h:22
connect to the write signal of the callback stream in order to process all text written to the stream
ComponentFormat
define standard formats, which should be used to avoid wrong assignment of component names
RenderAPI
enumeration of rendering APIs which can be queried from the context
Definition context.h:70
CullingMode
different culling modes
Definition context.h:143
cgv::data::ref_ptr< render_config > render_config_ptr
type of ref counted pointer to render configuration
Definition context.h:605
cgv::data::ref_ptr< context_config > context_config_ptr
type of ref counted pointer to context creation configuration
Definition context.h:571
void register_context_factory(context_creation_function_type fp)
registration context creation functions
Definition context.cxx:2430
BlendFunction
different blend functions
Definition context.h:150
TextAlignment
different text alignments
Definition context.h:273
@ TA_TOP
center of top edge of text bounds
Definition context.h:277
@ TA_BOTTOM_RIGHT
bottom right corner of text bounds
Definition context.h:282
@ TA_BOTTOM
center of bottom edge of text bounds
Definition context.h:278
@ TA_NONE
no alignment
Definition context.h:274
@ TA_RIGHT
center of right edge of text bounds
Definition context.h:276
@ TA_BOTTOM_LEFT
bottom left corner of text bounds
Definition context.h:281
@ TA_TOP_LEFT
top left corner of text bounds
Definition context.h:279
@ TA_LEFT
center of left edge of text bounds
Definition context.h:275
@ TA_TOP_RIGHT
top right corner of text bounds
Definition context.h:280
AccessType
different access types
Definition context.h:266
std::string get_render_pass_name(RenderPass rp)
convert render pass type into string
Definition context.cxx:728
TextureFilter
different texture filter
Definition context.h:189
render_config_ptr get_render_config()
return a pointer to the current shader configuration
Definition context.cxx:122
TextureWrap
different texture wrap modes
Definition context.h:173
FrameBufferType
different frame buffer types which can be combined together with or
Definition context.h:488
MaterialSide
different sides of a material
Definition context.h:128
TextureSampling
different sampling strategies for rendering to textures that steer the computation of the tex_coord i...
Definition context.h:247
@ TS_VERTEX
tex_coord ranges from [0,0,0] to [1,1,1]
Definition context.h:249
@ TS_CELL
for texture resulution N x M x L the tex_coord ranges from [1/2N, 1/2M, 1/2L] to [1-1/2N,...
Definition context.h:248
ElementType
different compond types for data elements
Definition context.h:39
context * create_context(RenderAPI api, unsigned int w, unsigned int h, const std::string &title, bool show)
construct a context of the given size.
Definition context.cxx:2443
VertexBufferUsage
Provides vertex buffer usage hints as defined in OpenGL.
Definition context.h:427
@ VBU_STATIC_COPY
Modified once and used many times; Modified by reading data from the GL, and used as the source for G...
Definition context.h:438
@ VBU_STREAM_COPY
Modified once and used at most a few times; Modified by reading data from the GL, and used as the sou...
Definition context.h:432
@ VBU_DYNAMIC_DRAW
Modified repeatedly and used many times; Modified by the application, and used as the source for GL d...
Definition context.h:440
@ VBU_STREAM_READ
Modified once and used at most a few times; Modified by reading data from the GL, and used to return ...
Definition context.h:430
@ VBU_DYNAMIC_COPY
Modified repeatedly and used many times; Modified by reading data from the GL, and used as the source...
Definition context.h:444
@ VBU_STATIC_READ
Modified once and used many times; Modified by reading data from the GL, and used to return that data...
Definition context.h:436
@ VBU_STATIC_DRAW
Modified once and used many times; Modified by the application, and used as the source for GL drawing...
Definition context.h:434
@ VBU_DYNAMIC_READ
Modified repeatedly and used many times; Modified by reading data from the GL, and used to return tha...
Definition context.h:442
@ VBU_STREAM_DRAW
Modified once and used at most a few times; Modified by the application, and used as the source for G...
Definition context.h:428
TextureCubeSides
the six different sides of a cube
Definition context.h:215
IlluminationMode
different illumination modes
Definition context.h:136
ContextIntegerConstant
integer constants that can be queried from context
Definition context.h:508
ShaderType
different shader types
Definition context.h:485
PrimitiveType
different primitive types
Definition context.h:225
VertexBufferType
Provides vertex buffer types to allow implicit binding.
Definition context.h:414
@ VBT_VERTICES
The buffer contains vertices and will be bound to GL_ARRAY_BUFFER.
Definition context.h:416
@ VBT_TEXTURE
The buffer contains texture data and will be bound to GL_TEXTURE_BUFFER.
Definition context.h:418
@ VBT_UNDEF
The buffer has no type.
Definition context.h:415
@ VBT_INDICES
The buffer contains indices and will be bound to GL_ELEMENT_ARRAY_BUFFER.
Definition context.h:417
@ VBT_ATOMIC_COUNTER
The buffer contains atomic counter and will be bound to GL_ATOMIC_COUNTER_BUFFER.
Definition context.h:422
@ VBT_STORAGE
The buffer contains arbitrary data and will be bound to GL_SHADER_STORAGE_BUFFER.
Definition context.h:421
@ VBT_UNIFORM
The buffer contains uniforms and will be bound to GL_UNIFORM_BUFFER.
Definition context.h:419
@ VBT_INDIRECT
The buffer contains indirect draw commands and will be bound to GL_DRAW_INDIRECT_BUFFER.
Definition context.h:423
@ VBT_FEEDBACK
The buffer is used for transform&feedback and will be bound to GL_TRANSFORM_FEEDBACK_BUFFER.
Definition context.h:420
BufferTypeBits
Bits for the selection of different buffer types.
Definition context.h:461
@ BTB_COLOR_BIT
color buffer type
Definition context.h:462
@ BTB_STENCIL_BIT
stencil buffer type
Definition context.h:465
@ BTB_ALL_BITS
all buffer types
Definition context.h:466
@ BTB_COLOR_AND_DEPTH_BITS
color and depth buffer types
Definition context.h:464
@ BTB_DEPTH_BIT
depth buffer type
Definition context.h:463
RenderPass
Enumeration of different render passes, which can be queried from the context and used to specify a n...
Definition context.h:77
@ RP_SHADOW_VOLUME
construction of shadow map
Definition context.h:82
@ RP_STEREO
rendering of second eye
Definition context.h:80
@ RP_USER_DEFINED
user defined renderpass
Definition context.h:86
@ RP_OPAQUE_SURFACES
opaque surface rendering using z-Buffer
Definition context.h:83
@ RP_NONE
no renderpass
Definition context.h:78
@ RP_MAIN
the main rendering pass triggered by the redraw event
Definition context.h:79
@ RP_TRANSPARENT_SURFACES
transparent surface rendering using depth peeling
Definition context.h:84
@ RP_PICK
in picking pass a small rectangle around the mouse is rendered
Definition context.h:85
@ RP_SHADOW_MAP
construction of shadow map
Definition context.h:81
TextureType
different texture types
Definition context.h:201
RenderPassFlags
available flags that can be queried from the context and set for a new render pass
Definition context.h:93
@ RPF_CLEAR_ACCUM
whether to clear the accumulation buffer
Definition context.h:108
@ RPF_SET_MODELVIEW
whether to set default modelview matrix
Definition context.h:96
@ RPF_DRAWABLES_FINISH_FRAME
whether to call finish frame method of drawables
Definition context.h:118
@ RPF_SET_MATERIAL
whether to define default material
Definition context.h:100
@ RPF_SET_CLEAR_DEPTH
whether to set the clear color
Definition context.h:114
@ RPF_ALL
all flags set, defines default render pass
Definition context.h:122
@ RPF_SET_LIGHTS
whether to define default lights
Definition context.h:99
@ RPF_CLEAR_COLOR
whether to clear the color buffer
Definition context.h:105
@ RPF_DRAWABLES_DRAW
whether to call draw and finish_draw methods of drawables
Definition context.h:117
@ RPF_CLEAR_STENCIL
whether to clear the depth buffer
Definition context.h:107
@ RPF_SET_MODELVIEW_PROJECTION
whether to set default modelview and projection matrix
Definition context.h:97
@ RPF_SET_CLEAR_STENCIL
whether to set the clear color
Definition context.h:115
@ RPF_ENABLE_MATERIAL
whether to enable material
Definition context.h:102
@ RPF_DRAWABLES_INIT_FRAME
whether to call the init_frame method of the drawables
Definition context.h:111
@ RPF_DRAWABLES_AFTER_FINISH
whether to call after finish method of drawables
Definition context.h:120
@ RPF_DEFAULT
all flags set, defines default render pass
Definition context.h:123
@ RPF_NONE
no frame initialization is performed
Definition context.h:94
@ RPF_HANDLE_SCREEN_SHOT
whether to perform a screen shot if this was scheduled
Definition context.h:121
@ RPF_CLEAR_DEPTH
whether to clear the depth buffer
Definition context.h:106
@ RPF_SET_STATE_FLAGS
whether to set depth buffer and culling flags
Definition context.h:112
@ RPF_CLEAR_ALL
whether to clear all buffers
Definition context.h:109
@ RPF_DRAW_TEXTUAL_INFO
whether to draw textual information
Definition context.h:119
@ RPF_SET_PROJECTION
whether to set default projection matrix
Definition context.h:95
@ RPF_SET_LIGHTING
whether to define and enable default lighting
Definition context.h:103
@ RPF_SET_CLEAR_ACCUM
whether to set the accumulation buffer clear color
Definition context.h:116
@ RPF_SET_CLEAR_COLOR
whether to set the clear color
Definition context.h:113
@ RPF_SET_LIGHTS_ON
whether to turn on default lights
Definition context.h:101
CompareFunction
different comparison functions used for depth testing or texture comparisons
Definition context.h:254
GPUVendorID
IDs for GPU vendors.
Definition context.h:31
TypeId
ids for the different types and type constructs
Definition type_id.h:12
@ TI_UINT8
signed integer stored in 64 bits
Definition type_id.h:23
the cgv namespace
Definition print.h:11
cgv::math::fmat< double, 4, 4 > dmat4
declare type of 4x4 matrices
Definition fmat.h:369
cgv::math::mat< double > dmatn
declare type of matrices of varying dimensions
Definition mat.h:1383
Represents a blend state used to configure fragment blending.
Definition context.h:645
Represents a buffer mask used to mask depth and color buffer outputs.
Definition context.h:660
Represents a depth test state used to configure depth testing.
Definition context.h:637
status information of light sources
Definition context.h:740
information necessary for a rendering pass
Definition context.h:768
configuration object used to define context parameters that need to be set already at creation time
Definition context.h:525
bool multi_sample_buffer
default: false
Definition context.h:541
bool stencil_buffer
default: false
Definition context.h:537
int version_minor
default: -1 ... minor version of maximum supported OpenGL version
Definition context.h:554
int depth_bits
default: -1
Definition context.h:543
bool double_buffer
default: true
Definition context.h:531
int version_major
default: -1 ... major version of maximum supported OpenGL version
Definition context.h:552
bool debug
default: false in release and true in debug version
Definition context.h:558
bool forward_compatible
default: false
Definition context.h:556
std::vector< int > context_creation_attrib_list
provide integer vector to store context creation attribute list
Definition context.h:567
bool stereo_buffer
default: false
Definition context.h:535
bool alpha_buffer
default: false
Definition context.h:533
bool core_profile
default: true
Definition context.h:560
int stencil_bits
default: -1
Definition context.h:545
int nr_multi_samples
default: -1
Definition context.h:549
bool accumulation_buffer
default: false
Definition context.h:539
int accumulation_bits
default: -1
Definition context.h:547
bool depth_buffer
default: true
Definition context.h:529
configuration object used to define render view creation parameters including error handling configur...
Definition context.h:575
int window_width
default: 640
Definition context.h:581
bool dialog_on_error
default: true (only in case a gui_driver, which supports this, is loaded)
Definition context.h:591
int fullscreen_monitor
default: -1 ... no fullscreen
Definition context.h:579
int window_height
default: 480
Definition context.h:583
bool abort_on_error
default: false
Definition context.h:589
bool show_error_on_console
default: true
Definition context.h:593
compact type description of data that can be sent to the context; convertible to int
Definition context.h:47
type_descriptor(const type_descriptor &td, bool _is_array)
construct descriptor for an array
Definition context.h:64
type_descriptor(cgv::type::info::TypeId _coordinate_type, bool _normalize=false)
construct descriptor for values
Definition context.h:58
type_descriptor(cgv::type::info::TypeId _coordinate_type, unsigned _nr_rows, unsigned _nr_cols, bool _is_row_major, bool _normalize=false)
construct descriptor for matrices
Definition context.h:62
type_descriptor(cgv::type::info::TypeId _coordinate_type, unsigned _nr_entries, bool _normalize=false)
construct descriptor for vectors
Definition context.h:60
type_descriptor(int td=0)
construct from int
Definition context.h:56
parameters necessary to define window transformation
Definition context.h:612
dvec2 depth_range
range of depth values [min_depth, max_depth]
Definition context.h:616
ivec4 viewport
viewport parameters [x0,y0,width,height]
Definition context.h:614