osg::DisplaySettings Class Reference

DisplaySettings class for encapsulating what visuals are required and have been set up, and the status of stereo viewing. More...

Inheritance diagram for osg::DisplaySettings:

[legend]

List of all members.

Public Types
enum	DisplayType { MONITOR, POWERWALL, REALITY_CENTER, HEAD_MOUNTED_DISPLAY }
enum	StereoMode {   QUAD_BUFFER, ANAGLYPHIC, HORIZONTAL_SPLIT, VERTICAL_SPLIT,   LEFT_EYE, RIGHT_EYE, HORIZONTAL_INTERLACE, VERTICAL_INTERLACE,   CHECKERBOARD }
enum	SplitStereoHorizontalEyeMapping { LEFT_EYE_LEFT_VIEWPORT, LEFT_EYE_RIGHT_VIEWPORT }
enum	SplitStereoVerticalEyeMapping { LEFT_EYE_TOP_VIEWPORT, LEFT_EYE_BOTTOM_VIEWPORT }
Public Member Functions
	DisplaySettings ()
	DisplaySettings (ArgumentParser &arguments)
	DisplaySettings (const DisplaySettings &vs)
DisplaySettings &	operator= (const DisplaySettings &vs)
void	setDisplaySettings (const DisplaySettings &vs)
void	merge (const DisplaySettings &vs)
void	setDefaults ()
void	readEnvironmentalVariables ()
	read the environmental variables.
void	readCommandLine (ArgumentParser &arguments)
	read the commandline arguments.
void	setDisplayType (DisplayType type)
DisplayType	getDisplayType () const
void	setStereo (bool on)
bool	getStereo () const
void	setStereoMode (StereoMode mode)
StereoMode	getStereoMode () const
void	setEyeSeparation (float eyeSeparation)
float	getEyeSeparation () const
void	setSplitStereoHorizontalEyeMapping (SplitStereoHorizontalEyeMapping m)
SplitStereoHorizontalEyeMapping	getSplitStereoHorizontalEyeMapping () const
void	setSplitStereoHorizontalSeparation (int s)
int	getSplitStereoHorizontalSeparation () const
void	setSplitStereoVerticalEyeMapping (SplitStereoVerticalEyeMapping m)
SplitStereoVerticalEyeMapping	getSplitStereoVerticalEyeMapping () const
void	setSplitStereoVerticalSeparation (int s)
int	getSplitStereoVerticalSeparation () const
void	setSplitStereoAutoAdjustAspectRatio (bool flag)
bool	getSplitStereoAutoAdjustAspectRatio () const
void	setScreenWidth (float width)
float	getScreenWidth () const
void	setScreenHeight (float height)
float	getScreenHeight () const
void	setScreenDistance (float distance)
float	getScreenDistance () const
void	setDoubleBuffer (bool flag)
bool	getDoubleBuffer () const
void	setRGB (bool flag)
bool	getRGB () const
void	setDepthBuffer (bool flag)
bool	getDepthBuffer () const
void	setMinimumNumAlphaBits (unsigned int bits)
unsigned int	getMinimumNumAlphaBits () const
bool	getAlphaBuffer () const
void	setMinimumNumStencilBits (unsigned int bits)
unsigned int	getMinimumNumStencilBits () const
bool	getStencilBuffer () const
void	setMinimumNumAccumBits (unsigned int red, unsigned int green, unsigned int blue, unsigned int alpha)
unsigned int	getMinimumNumAccumRedBits () const
unsigned int	getMinimumNumAccumGreenBits () const
unsigned int	getMinimumNumAccumBlueBits () const
unsigned int	getMinimumNumAccumAlphaBits () const
bool	getAccumBuffer () const
void	setMaxNumberOfGraphicsContexts (unsigned int num)
unsigned int	getMaxNumberOfGraphicsContexts () const
void	setNumMultiSamples (unsigned int samples)
unsigned int	getNumMultiSamples () const
bool	getMultiSamples () const
void	setCompileContextsHint (bool useCompileContexts)
bool	getCompileContextsHint () const
void	setSerializeDrawDispatch (bool serializeDrawDispatch)
bool	getSerializeDrawDispatch () const
Static Public Member Functions
static DisplaySettings *	instance ()
	Maintain a DisplaySettings singleton for objects to query at runtime.
Protected Member Functions
virtual	~DisplaySettings ()
Protected Attributes
DisplayType	_displayType
bool	_stereo
StereoMode	_stereoMode
float	_eyeSeparation
float	_screenWidth
float	_screenHeight
float	_screenDistance
SplitStereoHorizontalEyeMapping	_splitStereoHorizontalEyeMapping
int	_splitStereoHorizontalSeparation
SplitStereoVerticalEyeMapping	_splitStereoVerticalEyeMapping
int	_splitStereoVerticalSeparation
bool	_splitStereoAutoAdjustAspectRatio
bool	_doubleBuffer
bool	_RGB
bool	_depthBuffer
unsigned int	_minimumNumberAlphaBits
unsigned int	_minimumNumberStencilBits
unsigned int	_minimumNumberAccumRedBits
unsigned int	_minimumNumberAccumGreenBits
unsigned int	_minimumNumberAccumBlueBits
unsigned int	_minimumNumberAccumAlphaBits
unsigned int	_maxNumOfGraphicsContexts
unsigned int	_numMultiSamples
bool	_compileContextsHint
bool	_serializeDrawDispatch

---

Detailed Description

DisplaySettings class for encapsulating what visuals are required and have been set up, and the status of stereo viewing.

---

Member Enumeration Documentation

enum osg::DisplaySettings::DisplayType

Enumerator:

MONITOR
POWERWALL
REALITY_CENTER
HEAD_MOUNTED_DISPLAY

enum osg::DisplaySettings::StereoMode

Enumerator:

QUAD_BUFFER
ANAGLYPHIC
HORIZONTAL_SPLIT
VERTICAL_SPLIT
LEFT_EYE
RIGHT_EYE
HORIZONTAL_INTERLACE
VERTICAL_INTERLACE
CHECKERBOARD

enum osg::DisplaySettings::SplitStereoHorizontalEyeMapping

Enumerator:

LEFT_EYE_LEFT_VIEWPORT
LEFT_EYE_RIGHT_VIEWPORT

enum osg::DisplaySettings::SplitStereoVerticalEyeMapping

Enumerator:

LEFT_EYE_TOP_VIEWPORT
LEFT_EYE_BOTTOM_VIEWPORT

---

Constructor & Destructor Documentation

osg::DisplaySettings::DisplaySettings

(

)

[inline]

osg::DisplaySettings::DisplaySettings

(

ArgumentParser &

arguments

)

[inline]

osg::DisplaySettings::DisplaySettings

(

const DisplaySettings &

vs

)

virtual osg::DisplaySettings::~DisplaySettings

(

)

[protected, virtual]

---

Member Function Documentation

static DisplaySettings* osg::DisplaySettings::instance

(

)

[static]

Maintain a DisplaySettings singleton for objects to query at runtime.

DisplaySettings& osg::DisplaySettings::operator=

(

const DisplaySettings &

vs

)

void osg::DisplaySettings::setDisplaySettings

(

const DisplaySettings &

vs

)

void osg::DisplaySettings::merge

(

const DisplaySettings &

vs

)

void osg::DisplaySettings::setDefaults

(

)

void osg::DisplaySettings::readEnvironmentalVariables

(

)

read the environmental variables.

void osg::DisplaySettings::readCommandLine

(

ArgumentParser &

arguments

)

read the commandline arguments.

void osg::DisplaySettings::setDisplayType

(

DisplayType

type

)

[inline]

DisplayType osg::DisplaySettings::getDisplayType

(

)

const [inline]

void osg::DisplaySettings::setStereo

(

bool

on

)

[inline]

bool osg::DisplaySettings::getStereo

(

)

const [inline]

void osg::DisplaySettings::setStereoMode

(

StereoMode

mode

)

[inline]

StereoMode osg::DisplaySettings::getStereoMode

(

)

const [inline]

void osg::DisplaySettings::setEyeSeparation

(

float

eyeSeparation

)

[inline]

float osg::DisplaySettings::getEyeSeparation

(

)

const [inline]

void osg::DisplaySettings::setSplitStereoHorizontalEyeMapping

(

SplitStereoHorizontalEyeMapping

m

)

[inline]

SplitStereoHorizontalEyeMapping osg::DisplaySettings::getSplitStereoHorizontalEyeMapping

(

)

const [inline]

void osg::DisplaySettings::setSplitStereoHorizontalSeparation

(

int

s

)

[inline]

int osg::DisplaySettings::getSplitStereoHorizontalSeparation

(

)

const [inline]

void osg::DisplaySettings::setSplitStereoVerticalEyeMapping

(

SplitStereoVerticalEyeMapping

m

)

[inline]

SplitStereoVerticalEyeMapping osg::DisplaySettings::getSplitStereoVerticalEyeMapping

(

)

const [inline]

void osg::DisplaySettings::setSplitStereoVerticalSeparation

(

int

s

)

[inline]

int osg::DisplaySettings::getSplitStereoVerticalSeparation

(

)

const [inline]

void osg::DisplaySettings::setSplitStereoAutoAdjustAspectRatio

(

bool

flag

)

[inline]

bool osg::DisplaySettings::getSplitStereoAutoAdjustAspectRatio

(

)

const [inline]

void osg::DisplaySettings::setScreenWidth

(

float

width

)

[inline]

float osg::DisplaySettings::getScreenWidth

(

)

const [inline]

void osg::DisplaySettings::setScreenHeight

(

float

height

)

[inline]

float osg::DisplaySettings::getScreenHeight

(

)

const [inline]

void osg::DisplaySettings::setScreenDistance

(

float

distance

)

[inline]

float osg::DisplaySettings::getScreenDistance

(

)

const [inline]

void osg::DisplaySettings::setDoubleBuffer

(

bool

flag

)

[inline]

bool osg::DisplaySettings::getDoubleBuffer

(

)

const [inline]

void osg::DisplaySettings::setRGB

(

bool

flag

)

[inline]

bool osg::DisplaySettings::getRGB

(

)

const [inline]

void osg::DisplaySettings::setDepthBuffer

(

bool

flag

)

[inline]

bool osg::DisplaySettings::getDepthBuffer

(

)

const [inline]

void osg::DisplaySettings::setMinimumNumAlphaBits

(

unsigned int

bits

)

[inline]

unsigned int osg::DisplaySettings::getMinimumNumAlphaBits

(

)

const [inline]

bool osg::DisplaySettings::getAlphaBuffer

(

)

const [inline]

void osg::DisplaySettings::setMinimumNumStencilBits

(

unsigned int

bits

)

[inline]

unsigned int osg::DisplaySettings::getMinimumNumStencilBits

(

)

const [inline]

bool osg::DisplaySettings::getStencilBuffer

(

)

const [inline]

void osg::DisplaySettings::setMinimumNumAccumBits	(	unsigned int	red,
		unsigned int	green,
		unsigned int	blue,
		unsigned int	alpha
	)

unsigned int osg::DisplaySettings::getMinimumNumAccumRedBits

(

)

const [inline]

unsigned int osg::DisplaySettings::getMinimumNumAccumGreenBits

(

)

const [inline]

unsigned int osg::DisplaySettings::getMinimumNumAccumBlueBits

(

)

const [inline]

unsigned int osg::DisplaySettings::getMinimumNumAccumAlphaBits

(

)

const [inline]

bool osg::DisplaySettings::getAccumBuffer

(

)

const [inline]

void osg::DisplaySettings::setMaxNumberOfGraphicsContexts

(

unsigned int

num

)

unsigned int osg::DisplaySettings::getMaxNumberOfGraphicsContexts

(

)

const

void osg::DisplaySettings::setNumMultiSamples

(

unsigned int

samples

)

[inline]

unsigned int osg::DisplaySettings::getNumMultiSamples

(

)

const [inline]

bool osg::DisplaySettings::getMultiSamples

(

)

const [inline]

void osg::DisplaySettings::setCompileContextsHint

(

bool

useCompileContexts

)

[inline]

bool osg::DisplaySettings::getCompileContextsHint

(

)

const [inline]

void osg::DisplaySettings::setSerializeDrawDispatch

(

bool

serializeDrawDispatch

)

[inline]

bool osg::DisplaySettings::getSerializeDrawDispatch

(

)

const [inline]

---

Member Data Documentation

DisplayType osg::DisplaySettings::_displayType [protected]

bool osg::DisplaySettings::_stereo [protected]

StereoMode osg::DisplaySettings::_stereoMode [protected]

float osg::DisplaySettings::_eyeSeparation [protected]

float osg::DisplaySettings::_screenWidth [protected]

float osg::DisplaySettings::_screenHeight [protected]

float osg::DisplaySettings::_screenDistance [protected]

SplitStereoHorizontalEyeMapping osg::DisplaySettings::_splitStereoHorizontalEyeMapping [protected]

int osg::DisplaySettings::_splitStereoHorizontalSeparation [protected]

SplitStereoVerticalEyeMapping osg::DisplaySettings::_splitStereoVerticalEyeMapping [protected]

int osg::DisplaySettings::_splitStereoVerticalSeparation [protected]

bool osg::DisplaySettings::_splitStereoAutoAdjustAspectRatio [protected]

bool osg::DisplaySettings::_doubleBuffer [protected]

bool osg::DisplaySettings::_RGB [protected]

bool osg::DisplaySettings::_depthBuffer [protected]

unsigned int osg::DisplaySettings::_minimumNumberAlphaBits [protected]

unsigned int osg::DisplaySettings::_minimumNumberStencilBits [protected]

unsigned int osg::DisplaySettings::_minimumNumberAccumRedBits [protected]

unsigned int osg::DisplaySettings::_minimumNumberAccumGreenBits [protected]

unsigned int osg::DisplaySettings::_minimumNumberAccumBlueBits [protected]

unsigned int osg::DisplaySettings::_minimumNumberAccumAlphaBits [protected]

unsigned int osg::DisplaySettings::_maxNumOfGraphicsContexts [protected]

unsigned int osg::DisplaySettings::_numMultiSamples [protected]

bool osg::DisplaySettings::_compileContextsHint [protected]

bool osg::DisplaySettings::_serializeDrawDispatch [protected]

---

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

• DisplaySettings

---