vl::OpenGLContextFormat Class Reference

The OpenGLContextFormat class encapsulates the settings of an OpenGL rendering context. More...

#include <OpenGLContext.hpp>

List of all members.

Public Member Functions
	OpenGLContextFormat ()
void	setRGBABits (int r, int g, int b, int a)
void	setAccumRGBABits (int r, int g, int b, int a)
void	setDoubleBuffer (bool double_buffer_on)
void	setDepthBufferBits (int bits)
void	setStencilBufferBits (int bits)
void	setMultisample (bool multisample_on)
void	setMultisampleSamples (int samples)
void	setStereo (bool stereo_on)
void	setFullscreen (bool fullscreent)
void	setVSync (bool vsync_on)
void	setContextClientVersion (int version)
	Used by EGLWindow to initialize either GLES 1.x or GLES 2.x contexts.
const ivec4 &	rgbaBits () const
const ivec4 &	accumRGBABits () const
bool	doubleBuffer () const
int	depthBufferBits () const
int	stencilBufferBits () const
bool	multisample () const
int	multisampleSamples () const
bool	stereo () const
bool	fullscreen () const
bool	vSync () const
int	contextClientVersion () const
	Used by EGLWindow to initialize either GLES 1.x or GLES 2.x contexts.
int	bitsPerPixel () const
	Returns rgbaBits().r() + rgbaBits().g() + rgbaBits().b() + rgbaBits().a()
Protected Attributes
ivec4	mRGBABits
ivec4	mAccumRGBABits
bool	mHasDoubleBuffer
int	mZBufferBits
int	mStencilBufferBits
bool	mHasMultisample
int	mMultisampleSamples
bool	mStereo
bool	mFullscreen
bool	mVSync
int	mContextClientVersion

---

Detailed Description

The OpenGLContextFormat class encapsulates the settings of an OpenGL rendering context.

Definition at line 55 of file OpenGLContext.hpp.

---

Constructor & Destructor Documentation

vl::OpenGLContextFormat::OpenGLContextFormat

(

)

[inline]

Definition at line 58 of file OpenGLContext.hpp.

---

Member Function Documentation

void vl::OpenGLContextFormat::setRGBABits	(	int	r,
		int	g,
		int	b,
		int	a
	)		[inline]

Definition at line 71 of file OpenGLContext.hpp.

References mRGBABits.

void vl::OpenGLContextFormat::setAccumRGBABits	(	int	r,
		int	g,
		int	b,
		int	a
	)		[inline]

Definition at line 72 of file OpenGLContext.hpp.

References mAccumRGBABits.

void vl::OpenGLContextFormat::setDoubleBuffer

(

bool

double_buffer_on )

[inline]

Definition at line 73 of file OpenGLContext.hpp.

References mHasDoubleBuffer.

void vl::OpenGLContextFormat::setDepthBufferBits

(

int

bits )

[inline]

Definition at line 74 of file OpenGLContext.hpp.

References mZBufferBits.

void vl::OpenGLContextFormat::setStencilBufferBits

(

int

bits )

[inline]

Definition at line 75 of file OpenGLContext.hpp.

References mStencilBufferBits.

void vl::OpenGLContextFormat::setMultisample

(

bool

multisample_on )

[inline]

Definition at line 76 of file OpenGLContext.hpp.

References mHasMultisample.

void vl::OpenGLContextFormat::setMultisampleSamples

(

int

samples )

[inline]

Definition at line 77 of file OpenGLContext.hpp.

References mMultisampleSamples.

void vl::OpenGLContextFormat::setStereo

(

bool

stereo_on )

[inline]

Definition at line 78 of file OpenGLContext.hpp.

References mStereo.

void vl::OpenGLContextFormat::setFullscreen

(

bool

fullscreent )

[inline]

Definition at line 79 of file OpenGLContext.hpp.

References mFullscreen.

void vl::OpenGLContextFormat::setVSync

(

bool

vsync_on )

[inline]

Definition at line 80 of file OpenGLContext.hpp.

References mVSync.

void vl::OpenGLContextFormat::setContextClientVersion

(

int

version )

[inline]

Used by EGLWindow to initialize either GLES 1.x or GLES 2.x contexts.

Definition at line 82 of file OpenGLContext.hpp.

References mContextClientVersion.

const ivec4& vl::OpenGLContextFormat::rgbaBits

(

)

const [inline]

Definition at line 84 of file OpenGLContext.hpp.

References mRGBABits.

Referenced by bitsPerPixel(), vlWin32::choosePixelFormat(), vlEGL::EGLWindow::initEGLWindow(), vlGLUT::GLUTWindow::initGLUTWindow(), vlQt4::Qt4Widget::initQt4Widget(), and vlSDL::SDLWindow::initSDLWindow().

const ivec4& vl::OpenGLContextFormat::accumRGBABits

(

)

const [inline]

Definition at line 85 of file OpenGLContext.hpp.

References mAccumRGBABits.

Referenced by vlWin32::choosePixelFormat(), vlGLUT::GLUTWindow::initGLUTWindow(), vlQt4::Qt4Widget::initQt4Widget(), and vlSDL::SDLWindow::initSDLWindow().

bool vl::OpenGLContextFormat::doubleBuffer

(

)

const [inline]

Definition at line 86 of file OpenGLContext.hpp.

References mHasDoubleBuffer.

Referenced by vlWin32::choosePixelFormat(), vlGLUT::GLUTWindow::initGLUTWindow(), vlQt4::Qt4Widget::initQt4Widget(), and vlSDL::SDLWindow::initSDLWindow().

int vl::OpenGLContextFormat::depthBufferBits

(

)

const [inline]

Definition at line 87 of file OpenGLContext.hpp.

References mZBufferBits.

Referenced by vlWin32::choosePixelFormat(), vlEGL::EGLWindow::initEGLWindow(), vlGLUT::GLUTWindow::initGLUTWindow(), vlQt4::Qt4Widget::initQt4Widget(), and vlSDL::SDLWindow::initSDLWindow().

int vl::OpenGLContextFormat::stencilBufferBits

(

)

const [inline]

Definition at line 88 of file OpenGLContext.hpp.

References mStencilBufferBits.

Referenced by vlWin32::choosePixelFormat(), vlEGL::EGLWindow::initEGLWindow(), vlGLUT::GLUTWindow::initGLUTWindow(), vlQt4::Qt4Widget::initQt4Widget(), and vlSDL::SDLWindow::initSDLWindow().

bool vl::OpenGLContextFormat::multisample

(

)

const [inline]

Definition at line 89 of file OpenGLContext.hpp.

References mHasMultisample.

Referenced by vlWin32::choosePixelFormat(), vlEGL::EGLWindow::initEGLWindow(), vlGLUT::GLUTWindow::initGLUTWindow(), vlQt4::Qt4Widget::initQt4Widget(), vlSDL::SDLWindow::initSDLWindow(), and vlWin32::Win32Context::initWin32GLContext().

int vl::OpenGLContextFormat::multisampleSamples

(

)

const [inline]

Definition at line 90 of file OpenGLContext.hpp.

References mMultisampleSamples.

Referenced by vlWin32::choosePixelFormat(), vlEGL::EGLWindow::initEGLWindow(), vlQt4::Qt4Widget::initQt4Widget(), and vlSDL::SDLWindow::initSDLWindow().

bool vl::OpenGLContextFormat::stereo

(

)

const [inline]

Definition at line 91 of file OpenGLContext.hpp.

References mStereo.

Referenced by vlWin32::choosePixelFormat(), vlGLUT::GLUTWindow::initGLUTWindow(), vlQt4::Qt4Widget::initQt4Widget(), and vlSDL::SDLWindow::initSDLWindow().

bool vl::OpenGLContextFormat::fullscreen

(

)

const [inline]

Definition at line 92 of file OpenGLContext.hpp.

References mFullscreen.

Referenced by vlGLUT::GLUTWindow::initGLUTWindow(), vlQt4::Qt4Widget::initQt4Widget(), vlSDL::SDLWindow::initSDLWindow(), and vlWin32::Win32Context::initWin32GLContext().

bool vl::OpenGLContextFormat::vSync

(

)

const [inline]

Definition at line 93 of file OpenGLContext.hpp.

References mVSync.

Referenced by vlEGL::EGLWindow::initEGLWindow(), vlGLUT::GLUTWindow::initGLUTWindow(), vlQt4::Qt4Widget::initQt4Widget(), vlSDL::SDLWindow::initSDLWindow(), and vlWin32::Win32Context::initWin32GLContext().

int vl::OpenGLContextFormat::contextClientVersion

(

)

const [inline]

Used by EGLWindow to initialize either GLES 1.x or GLES 2.x contexts.

Definition at line 95 of file OpenGLContext.hpp.

References mContextClientVersion.

Referenced by vlEGL::EGLWindow::initEGLWindow().

int vl::OpenGLContextFormat::bitsPerPixel

(

)

const [inline]

Returns rgbaBits().r() + rgbaBits().g() + rgbaBits().b() + rgbaBits().a()

Definition at line 98 of file OpenGLContext.hpp.

References vl::Vector4< T_Scalar >::a(), vl::Vector4< T_Scalar >::b(), vl::Vector4< T_Scalar >::g(), vl::Vector4< T_Scalar >::r(), and rgbaBits().

---

Member Data Documentation

ivec4 vl::OpenGLContextFormat::mRGBABits [protected]

Definition at line 101 of file OpenGLContext.hpp.

Referenced by rgbaBits(), and setRGBABits().

ivec4 vl::OpenGLContextFormat::mAccumRGBABits [protected]

Definition at line 102 of file OpenGLContext.hpp.

Referenced by accumRGBABits(), and setAccumRGBABits().

bool vl::OpenGLContextFormat::mHasDoubleBuffer [protected]

Definition at line 103 of file OpenGLContext.hpp.

Referenced by doubleBuffer(), and setDoubleBuffer().

int vl::OpenGLContextFormat::mZBufferBits [protected]

Definition at line 104 of file OpenGLContext.hpp.

Referenced by depthBufferBits(), and setDepthBufferBits().

int vl::OpenGLContextFormat::mStencilBufferBits [protected]

Definition at line 105 of file OpenGLContext.hpp.

Referenced by setStencilBufferBits(), and stencilBufferBits().

bool vl::OpenGLContextFormat::mHasMultisample [protected]

Definition at line 106 of file OpenGLContext.hpp.

Referenced by multisample(), and setMultisample().

int vl::OpenGLContextFormat::mMultisampleSamples [protected]

Definition at line 107 of file OpenGLContext.hpp.

Referenced by multisampleSamples(), and setMultisampleSamples().

bool vl::OpenGLContextFormat::mStereo [protected]

Definition at line 108 of file OpenGLContext.hpp.

Referenced by setStereo(), and stereo().

bool vl::OpenGLContextFormat::mFullscreen [protected]

Definition at line 109 of file OpenGLContext.hpp.

Referenced by fullscreen(), and setFullscreen().

bool vl::OpenGLContextFormat::mVSync [protected]

Definition at line 110 of file OpenGLContext.hpp.

Referenced by setVSync(), and vSync().

int vl::OpenGLContextFormat::mContextClientVersion [protected]

Definition at line 111 of file OpenGLContext.hpp.

Referenced by contextClientVersion(), and setContextClientVersion().

---

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

• /home/master/UCL/VisualizationLibrary/src/vlGraphics/OpenGLContext.hpp