osg::GraphicsContext::GraphicsContext::ScreenIdentifier Struct Reference

Inheritance diagram for osg::GraphicsContext::GraphicsContext::ScreenIdentifier:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 ScreenIdentifier ()
 ScreenIdentifier (int in_screenNum)
 ScreenIdentifier (const std::string &in_hostName, int in_displayNum, int in_screenNum)
std::string displayName () const
 Return the display name in the form hostName::displayNum:screenNum.
void readDISPLAY ()
 Read the DISPLAY environmental variable, and set the ScreenIdentifier accordingly.
void setScreenIdentifier (const std::string &displayName)
 Set the screenIndentifier from the displayName string.
void setUndefinedScreenDetailsToDefaultScreen ()
 Set any undefined displayNum or screenNum values (i.e.

Public Attributes

std::string hostName
int displayNum
int screenNum


Constructor & Destructor Documentation

osg::GraphicsContext::GraphicsContext::ScreenIdentifier::ScreenIdentifier (  ) 

osg::GraphicsContext::GraphicsContext::ScreenIdentifier::ScreenIdentifier ( int  in_screenNum  ) 

osg::GraphicsContext::GraphicsContext::ScreenIdentifier::ScreenIdentifier ( const std::string &  in_hostName,
int  in_displayNum,
int  in_screenNum 
)


Member Function Documentation

std::string osg::GraphicsContext::GraphicsContext::ScreenIdentifier::displayName (  )  const

Return the display name in the form hostName::displayNum:screenNum.

void osg::GraphicsContext::GraphicsContext::ScreenIdentifier::readDISPLAY (  ) 

Read the DISPLAY environmental variable, and set the ScreenIdentifier accordingly.

Note, if either of displayNum or screenNum are not defined then -1 is set respectively to signify the this parameter has not been set. When parameters are undefined one can call call setUndefinedScreenDetalstoDefaultScreen() method after readDISPLAY() to ensure valid values.

void osg::GraphicsContext::GraphicsContext::ScreenIdentifier::setScreenIdentifier ( const std::string &  displayName  ) 

Set the screenIndentifier from the displayName string.

Note, if either of displayNum or screenNum are not defined then -1 is set respectively to signify the this parameter has not been set. When parameters are undefined one can call call setUndefinedScreenDetalstoDefaultScreen() method after readDISPLAY() to ensure valid values.

void osg::GraphicsContext::GraphicsContext::ScreenIdentifier::setUndefinedScreenDetailsToDefaultScreen (  )  [inline]

Set any undefined displayNum or screenNum values (i.e.

-1) to the default display & screen of 0 respectively.


Member Data Documentation

int osg::GraphicsContext::GraphicsContext::ScreenIdentifier::displayNum

std::string osg::GraphicsContext::GraphicsContext::ScreenIdentifier::hostName

int osg::GraphicsContext::GraphicsContext::ScreenIdentifier::screenNum


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

osg logo
Generated at Wed Aug 26 07:56:30 2009 for the OpenSceneGraph by doxygen 1.5.8.