OpenSceneGraph
Public Member Functions | Public Attributes | List of all members
osg::GraphicsContext::ScreenIdentifier Struct Reference
Inheritance diagram for osg::GraphicsContext::ScreenIdentifier:
Inheritance graph
[legend]
Collaboration diagram for osg::GraphicsContext::ScreenIdentifier:
Collaboration graph
[legend]

Public Member Functions

 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. More...
 
void readDISPLAY ()
 Read the DISPLAY environmental variable, and set the ScreenIdentifier accordingly. More...
 
void setScreenIdentifier (const std::string &displayName)
 Set the screenIndentifier from the displayName string. More...
 
void setUndefinedScreenDetailsToDefaultScreen ()
 Set any undefined displayNum or screenNum values (i.e. More...
 

Public Attributes

std::string hostName
 
int displayNum
 
int screenNum
 

Member Function Documentation

◆ displayName()

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

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

◆ readDISPLAY()

void osg::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 that this parameter has not been set. When parameters are undefined one can call call setUndefinedScreenDetailsToDefaultScreen() after readDISPLAY() to ensure valid values.

◆ setScreenIdentifier()

void osg::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 to signify that this parameter has not been set. When parameters are undefined one can call call setUndefinedScreenDetailsToDefaultScreen() after readDISPLAY() to ensure valid values.

◆ setUndefinedScreenDetailsToDefaultScreen()

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

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

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


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