cgv
Loading...
Searching...
No Matches
cgv::render::render_config Struct Reference

configuration object used to define render view creation parameters including error handling configuration More...

#include <context.h>

Inheritance diagram for cgv::render::render_config:
cgv::base::base cgv::render::context_config cgv::data::ref_counted cgv::reflect::self_reflection_tag

Public Attributes

window creation parameters
int fullscreen_monitor
 default: -1 ... no fullscreen
 
int window_width
 default: 640
 
int window_height
 default: 480
 
- Public Attributes inherited from cgv::render::context_config
bool depth_buffer
 default: true
 
bool double_buffer
 default: true
 
bool alpha_buffer
 default: false
 
bool stereo_buffer
 default: false
 
bool stencil_buffer
 default: false
 
bool accumulation_buffer
 default: false
 
bool multi_sample_buffer
 default: false
 
int depth_bits
 default: -1
 
int stencil_bits
 default: -1
 
int accumulation_bits
 default: -1
 
int nr_multi_samples
 default: -1
 
int version_major
 default: -1 ... major version of maximum supported OpenGL version
 
int version_minor
 default: -1 ... minor version of maximum supported OpenGL version
 
bool forward_compatible
 default: false
 
bool debug
 default: false in release and true in debug version
 
bool core_profile
 default: true
 
std::vector< int > context_creation_attrib_list
 provide integer vector to store context creation attribute list
 

error handling

bool abort_on_error
 default: false
 
bool dialog_on_error
 default: true (only in case a gui_driver, which supports this, is loaded)
 
bool show_error_on_console
 default: true
 
 render_config ()
 construct config with default parameters
 
std::string get_type_name () const
 return "render_config"
 
bool self_reflect (cgv::reflect::reflection_handler &srh)
 reflect the shader_path member
 

Additional Inherited Members

- Public Member Functions inherited from cgv::base::base
virtual std::string get_default_options () const
 overload to provide default options for registration
 
std::string get_name_or_type_name () const
 determine name of instance by checking cgv::base::named interface and in failure fallback to get_type_name()
 
virtual void on_register ()
 overload to handle register events that is sent after the instance has been registered
 
virtual void unregister ()
 overload to handle unregistration of instances
 
virtual bool on_exit_request ()
 overload to handle the appication exit request, return true if exiting is allowed and false otherwise
 
virtual void stream_stats (std::ostream &)
 overload to show the content of this object
 
virtual data::ref_ptr< named, trueget_named ()
 perform downcast to named
 
virtual data::ref_ptr< node, trueget_node ()
 perform downcast to node
 
virtual data::ref_ptr< group, trueget_group ()
 perform downcast to group
 
virtual data::ref_ptr< const named, trueget_named_const () const
 perform downcast to const named
 
virtual data::ref_ptr< const node, trueget_node_const () const
 perform downcast to const node
 
virtual data::ref_ptr< const group, trueget_group_const () const
 perform downcast to const group
 
template<class T >
data::ref_ptr< T, truecast ()
 cast to arbitrary class, but use the casts to named, node and group from the interface
 
template<class T >
data::ref_ptr< const T, truecast_const ()
 const cast to arbitrary class, but use the casts to named, node and group from the interface
 
template<class T >
Tget_interface ()
 use dynamic type cast to check for the given interface
 
template<class T >
const Tget_const_interface () const
 use dynamic type cast to check for the given interface
 
virtual void update ()
 this virtual update allows for example to ask a view to update the viewed value. The default implementation is empty.
 
virtual voidget_user_data () const
 this virtual method allows to pass application specific data for internal purposes
 
virtual std::string get_property_declarations ()
 return a semicolon separated list of property declarations
 
virtual bool set_void (const std::string &property, const std::string &value_type, const void *value_ptr)
 abstract interface for the setter of a dynamic property.
 
virtual void on_set (void *member_ptr)
 this callback is called when the set_void method has changed a member and can be overloaded in derived class
 
virtual bool get_void (const std::string &property, const std::string &value_type, void *value_ptr)
 abstract interface for the getter of a dynamic property.
 
virtual bool call_void (const std::string &method, const std::vector< std::string > &param_value_types, const std::vector< const void * > &param_value_ptrs, const std::string &result_type="", void *result_value_ptr=0)
 abstract interface to call an action
 
void set (const std::string &property, const char *value)
 specialization of set method to support const char* as strings
 
template<typename T >
void set (const std::string &property, const T &value)
 set a property of the element to the given value and perform standard conversions if necessary.
 
template<typename T >
T get (const std::string &property)
 query a property of the element and perform standard conversions if necessary.
 
void multi_set (const std::string &property_assignments, bool report_error=true)
 set several properties
 
bool is_property (const std::string &property_name, std::string *type_name=0)
 check if the given name specifies a property.
 
voidfind_member_ptr (const std::string &property_name, std::string *type_name=0)
 find a member pointer by name.
 
- Public Member Functions inherited from cgv::data::ref_counted
int get_ref_count () const
 read access to current count
 
- Public Member Functions inherited from cgv::render::context_config
 context_config ()
 construct config with default parameters
 
bool self_reflect (cgv::reflect::reflection_handler &srh)
 reflect the shader_path member
 
- Protected Member Functions inherited from cgv::base::base
virtual ~base ()
 make destructor virtual and not accessible from outside
 
- Protected Member Functions inherited from cgv::data::ref_counted
 ref_counted ()
 constructor initializes the count to 0
 
void set_ref_count (int c) const
 write access is also const to allow ref counted pointers to const instances
 
- Static Protected Member Functions inherited from cgv::base::base
template<class T >
static data::ref_ptr< T, truecast_dynamic (base *b)
 use dynamic cast for upcast to given class
 

Detailed Description

configuration object used to define render view creation parameters including error handling configuration

Definition at line 574 of file context.h.

Constructor & Destructor Documentation

◆ render_config()

cgv::render::render_config::render_config ( )

construct config with default parameters

default: -1 ... no fullscreen

default: 640

default: 480

default: false

default: true (only in case a gui_driver, which supports this, is loaded)

default: true

Definition at line 86 of file context.cxx.

References abort_on_error, dialog_on_error, fullscreen_monitor, show_error_on_console, window_height, and window_width.

Member Function Documentation

◆ get_type_name()

std::string cgv::render::render_config::get_type_name ( ) const
virtual

return "render_config"

Reimplemented from cgv::base::base.

Definition at line 103 of file context.cxx.

◆ self_reflect()

bool cgv::render::render_config::self_reflect ( cgv::reflect::reflection_handler srh)
virtual

reflect the shader_path member

Reimplemented from cgv::base::base.

Definition at line 109 of file context.cxx.

References abort_on_error, dialog_on_error, fullscreen_monitor, cgv::render::context_config::self_reflect(), show_error_on_console, window_height, and window_width.

Member Data Documentation

◆ abort_on_error

bool cgv::render::render_config::abort_on_error

default: false

Definition at line 589 of file context.h.

Referenced by render_config(), and self_reflect().

◆ dialog_on_error

bool cgv::render::render_config::dialog_on_error

default: true (only in case a gui_driver, which supports this, is loaded)

Definition at line 591 of file context.h.

Referenced by render_config(), and self_reflect().

◆ fullscreen_monitor

int cgv::render::render_config::fullscreen_monitor

default: -1 ... no fullscreen

Definition at line 579 of file context.h.

Referenced by render_config(), and self_reflect().

◆ show_error_on_console

bool cgv::render::render_config::show_error_on_console

default: true

Definition at line 593 of file context.h.

Referenced by render_config(), and self_reflect().

◆ window_height

int cgv::render::render_config::window_height

default: 480

Definition at line 583 of file context.h.

Referenced by render_config(), and self_reflect().

◆ window_width

int cgv::render::render_config::window_width

default: 640

Definition at line 581 of file context.h.

Referenced by render_config(), and self_reflect().


The documentation for this struct was generated from the following files: