Visualization Library v1.0.3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | Friends

vl::GlobalSettings Class Reference

Global application settings controlling how Visualization Library behaves. More...

#include <GlobalSettings.hpp>

Inheritance diagram for vl::GlobalSettings:
vl::Object

List of all members.

Public Member Functions

 GlobalSettings ()
void setCheckOpenGLStates (bool check_clean)
 If true VL checks at the beginning of each rendering that the OpenGL states are clean and ready to be used by VL.
bool checkOpenGLStates () const
 If true VL checks at the beginning of each rendering that the OpenGL states are clean and ready to be used by VL.
void setVerbosityLevel (EVerbosityLevel verb_level)
 The verbosity level of VL.
EVerbosityLevel verbosityLevel () const
 The verbosity level of VL.
const StringdefaultLogPath () const
 The path of the default log file.
const StringdefaultDataPath () const
 The path of the default data directory.

Protected Attributes

EVerbosityLevel mVerbosityLevel
bool mCheckOpenGLStates
String mDefaultLogPath
String mDefaultDataPath

Friends

class VisualizationLibrary

Detailed Description

Global application settings controlling how Visualization Library behaves.

Definition at line 41 of file GlobalSettings.hpp.


Constructor & Destructor Documentation

GlobalSettings::GlobalSettings (  )

Member Function Documentation

void vl::GlobalSettings::setCheckOpenGLStates ( bool  check_clean ) [inline]

If true VL checks at the beginning of each rendering that the OpenGL states are clean and ready to be used by VL.

If the test fails it can mean that either there is a bug in VL or that the user did not restore the OpenGL states to a VL friendly state after modifying them.

Note:
This can slow down the rendering. Enabled by default in DEBUG mode only.

Definition at line 55 of file GlobalSettings.hpp.

Referenced by GlobalSettings().

bool vl::GlobalSettings::checkOpenGLStates (  ) const [inline]

If true VL checks at the beginning of each rendering that the OpenGL states are clean and ready to be used by VL.

If the test fails it can mean that either there is a bug in VL or that the user did not restore the OpenGL states to a VL friendly state after modifying them.

Note:
This can slow down the rendering. Enabled by default in DEBUG mode only.

Definition at line 62 of file GlobalSettings.hpp.

void vl::GlobalSettings::setVerbosityLevel ( EVerbosityLevel  verb_level ) [inline]

The verbosity level of VL.

This applies to all the logs generated via vl::Log::*.

Definition at line 65 of file GlobalSettings.hpp.

Referenced by GlobalSettings().

EVerbosityLevel vl::GlobalSettings::verbosityLevel (  ) const [inline]

The verbosity level of VL.

This applies to all the logs generated via vl::Log::*.

Definition at line 68 of file GlobalSettings.hpp.

const String& vl::GlobalSettings::defaultLogPath (  ) const [inline]

The path of the default log file.

Definition at line 71 of file GlobalSettings.hpp.

const String& vl::GlobalSettings::defaultDataPath (  ) const [inline]

The path of the default data directory.

Definition at line 74 of file GlobalSettings.hpp.


Friends And Related Function Documentation

friend class VisualizationLibrary [friend]

Definition at line 43 of file GlobalSettings.hpp.


Member Data Documentation

Definition at line 77 of file GlobalSettings.hpp.

Referenced by GlobalSettings().

Definition at line 78 of file GlobalSettings.hpp.

Referenced by GlobalSettings().

Definition at line 79 of file GlobalSettings.hpp.

Referenced by GlobalSettings().

Definition at line 80 of file GlobalSettings.hpp.

Referenced by GlobalSettings().


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

Visualization Library v1.0.3 Reference Documentation
Copyright Michele Bosi. All rights reserved.
Updated on Tue Feb 7 2017 00:55:06.
Permission is granted to use this page to write and publish articles regarding Visualization Library.