om::system::DisplayID Class Reference

A class that is used to encapsulate a unique identifier for a system video display. More...

#include <omDisplayID.h>

Public Types
typedef PointerInt	IDType
	The underlying representation of a DisplayID, an unsigned integer. More...

Public Member Functions
	DisplayID ()
	Create a DisplayID object that represents an invalid display ID. More...
	DisplayID (const IDType &newDisplayID)
	Create a DisplayID object that represents the display with the specified device ID. More...
Bool	operator== (const DisplayID &other) const
	Return whether or not this display ID represents the same display as another. More...
Bool	operator!= (const DisplayID &other) const
	Return whether or not this display ID represents a different display than another. More...
Bool	isValid () const
	Return whether or not this DisplayID represents a valid display. More...
const IDType &	getID () const
	Return a const reference to the internal ID value representing a video display on this system. More...
	operator const IDType & () const
	Return a const reference to the internal ID value representing a video display on this system. More...

Static Public Attributes
static const DisplayID	INVALID
	An instance of DisplayID that represents an invalid video display. More...
static const IDType	INVALID_ID
	The reserved internal ID used to indicate an invalid display. More...

Detailed Description

A class that is used to encapsulate a unique identifier for a system video display.

This opaque type uses a platform-dependent internal representation which uniquely identifies a connected video display on this system.

Member Typedef Documentation

typedef PointerInt om::system::DisplayID::IDType

The underlying representation of a DisplayID, an unsigned integer.

Constructor & Destructor Documentation

om::system::DisplayID::DisplayID ( )

inlineexplicit

Create a DisplayID object that represents an invalid display ID.

om::system::DisplayID::DisplayID ( const IDType &  newDisplayID )

inlineexplicit

Create a DisplayID object that represents the display with the specified device ID.

Member Function Documentation

Bool om::system::DisplayID::operator== ( const DisplayID &  other ) const

inline

Return whether or not this display ID represents the same display as another.

Bool om::system::DisplayID::operator!= ( const DisplayID &  other ) const

inline

Return whether or not this display ID represents a different display than another.

Bool om::system::DisplayID::isValid ( ) const

inline

Return whether or not this DisplayID represents a valid display.

This condition is met whenever the display ID is not equal to INVALID_DISPLAY_ID.

const IDType& om::system::DisplayID::getID ( ) const

inline

Return a const reference to the internal ID value representing a video display on this system.

om::system::DisplayID::operator const IDType & ( ) const

inline

Return a const reference to the internal ID value representing a video display on this system.

Member Data Documentation

const DisplayID om::system::DisplayID::INVALID

static

An instance of DisplayID that represents an invalid video display.

const IDType om::system::DisplayID::INVALID_ID

static

The reserved internal ID used to indicate an invalid display.

---

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

• omDisplayID.h