Cinder  0.9.1
Public Member Functions | Protected Attributes | List of all members
cinder::app::RendererGl::Options Struct Reference

#include <RendererGl.h>

Public Member Functions

 Options ()
 
OptionscoreProfile (bool enable=true)
 
bool getCoreProfile () const
 
void setCoreProfile (bool enable)
 
Optionsversion (int major, int minor)
 
Optionsversion (std::pair< int, int > version)
 
std::pair< int, int > getVersion () const
 
void setVersion (int major, int minor)
 
void setVersion (std::pair< int, int > version)
 
Optionsmsaa (int samples)
 
int getMsaa () const
 
Optionsdebug ()
 
bool getDebug () const
 
OptionsdebugLog (GLenum severity=GL_DEBUG_SEVERITY_NOTIFICATION)
 
GLenum getDebugLogSeverity () const
 
OptionsdebugBreak (GLenum severity=GL_DEBUG_SEVERITY_HIGH)
 
GLenum getDebugBreakSeverity () const
 
OptionsobjectTracking (bool objectTracking=true)
 
bool getObjectTracking () const
 
OptionsdepthBufferDepth (int depthBufferBits)
 
int getDepthBufferDepth () const
 
void setDepthBufferDepth (int depthBufferBits)
 
Optionsstencil (bool createStencil=true)
 
bool getStencil () const
 
void setStencil (bool createStencil=true)
 
OptionscolorChannelDepth (int colorBitsPerChannel)
 
int getColorChannelDepth () const
 

Protected Attributes

bool mCoreProfile
 
std::pair< int, int > mVersion
 
int mMsaaSamples
 
bool mStencil
 
int mColorBpc
 
int mDepthBufferBits
 
bool mDebugContext
 
GLenum mDebugLogSeverity
 
GLenum mDebugBreakSeverity
 
bool mObjectTracking
 

Constructor & Destructor Documentation

cinder::app::RendererGl::Options::Options ( )

Member Function Documentation

Options& cinder::app::RendererGl::Options::coreProfile ( bool  enable = true)
bool cinder::app::RendererGl::Options::getCoreProfile ( ) const
void cinder::app::RendererGl::Options::setCoreProfile ( bool  enable)
Options& cinder::app::RendererGl::Options::version ( int  major,
int  minor 
)
Options& cinder::app::RendererGl::Options::version ( std::pair< int, int >  version)
std::pair<int,int> cinder::app::RendererGl::Options::getVersion ( ) const
void cinder::app::RendererGl::Options::setVersion ( int  major,
int  minor 
)
void cinder::app::RendererGl::Options::setVersion ( std::pair< int, int >  version)
Options& cinder::app::RendererGl::Options::msaa ( int  samples)

Sets the number of samples used for Multisample Anti-Aliasing (MSAA). Valid values are powers of 2 (0, 2, 4, 8, 16). Defaults to 0.

int cinder::app::RendererGl::Options::getMsaa ( ) const

Returns the number of samples used for Multisample Anti-Aliasing (MSAA).

Options& cinder::app::RendererGl::Options::debug ( )

Enables a debug context (per ARB_debug_output). Currently only implemented by MSW GL implementations. By default this is made GL_DEBUG_OUTPUT_SYNCHRONOUS.

bool cinder::app::RendererGl::Options::getDebug ( ) const

Returns whether the context has debug enabled.

Options& cinder::app::RendererGl::Options::debugLog ( GLenum  severity = GL_DEBUG_SEVERITY_NOTIFICATION)

Enables logging of an error of a given severity (or greater), such as GL_DEBUG_SEVERITY_NOTIFICATION. Implicitly enables the debug context. Off (0) by default.

GLenum cinder::app::RendererGl::Options::getDebugLogSeverity ( ) const

Returns the severity threshold for debug logging, such as GL_DEBUG_SEVERITY_LOW. A value of 0 indicates debugLog is off.

Options& cinder::app::RendererGl::Options::debugBreak ( GLenum  severity = GL_DEBUG_SEVERITY_HIGH)

Enables breaking on an error of a given severity (or greater), such as GL_DEBUG_SEVERITY_HIGH. Implicitly enables the debug context. Off (0) by default.

GLenum cinder::app::RendererGl::Options::getDebugBreakSeverity ( ) const

Returns the severity threshold for debug breaking. A value of 0 indicates debugBreak is off.

Options& cinder::app::RendererGl::Options::objectTracking ( bool  objectTracking = true)

Enables Context-level tracking of live objects. Defaults to false.

bool cinder::app::RendererGl::Options::getObjectTracking ( ) const

Returns whether Context-level tracking of live objects is enabled. Defaults to false.

Options& cinder::app::RendererGl::Options::depthBufferDepth ( int  depthBufferBits)

Sets the number of bits dedicated to the depth buffer. Default is 24.

int cinder::app::RendererGl::Options::getDepthBufferDepth ( ) const

Returns the number of bits dedicated to the depth buffer. Default is 24.

void cinder::app::RendererGl::Options::setDepthBufferDepth ( int  depthBufferBits)

Sets the number of bits dedicated to the depth buffer. Default is 24.

Options& cinder::app::RendererGl::Options::stencil ( bool  createStencil = true)

Enables or disables a stencil buffer. Default is false.

bool cinder::app::RendererGl::Options::getStencil ( ) const

Returns whether a stenci buffer is enabled. Default is false.

void cinder::app::RendererGl::Options::setStencil ( bool  createStencil = true)

Enables or disables a stencil buffer. Default is false.

Options& cinder::app::RendererGl::Options::colorChannelDepth ( int  colorBitsPerChannel)

Sets the number of bits per color channel. Default is 8 but can be 10 on professional GPUs (Quadro/FireGL)

int cinder::app::RendererGl::Options::getColorChannelDepth ( ) const

Returns the number of bits per color channel. Default is 8 but can be 10 on professional GPUs (Quadro/FireGL)

Member Data Documentation

bool cinder::app::RendererGl::Options::mCoreProfile
protected
std::pair<int,int> cinder::app::RendererGl::Options::mVersion
protected
int cinder::app::RendererGl::Options::mMsaaSamples
protected
bool cinder::app::RendererGl::Options::mStencil
protected
int cinder::app::RendererGl::Options::mColorBpc
protected
int cinder::app::RendererGl::Options::mDepthBufferBits
protected
bool cinder::app::RendererGl::Options::mDebugContext
protected
GLenum cinder::app::RendererGl::Options::mDebugLogSeverity
protected
GLenum cinder::app::RendererGl::Options::mDebugBreakSeverity
protected
bool cinder::app::RendererGl::Options::mObjectTracking
protected

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