ParCompMark::XDisplay Class Reference

#include <PCMXDisplay.h>

Collaboration diagram for ParCompMark::XDisplay:

Detailed Description

Class that encapsulates an X Display.

Definition at line 60 of file PCMXDisplay.h.


Getters & setters
const std::string &	getDisplayName () const
	Getter of mDisplayName.
::Display *	getDisplay () const
	Getter of mDisplay.
const bool &	getInitialized () const
	Getter of mInitialized.
const u32 &	getWidth () const
	Getter of mWidth.
const u32 &	getHeight () const
	Getter of mHeight.
static const bool &	getXMTInitialized ()
	Getter of mXMTInitialized.
static const bool &	getXMTSupported ()
	Getter of mXMTSupported.
static const Mutex &	getErrorHandlerMutex ()
	Getter of mErrorHandlerMutex.
static const bool &	getTolerateErrors ()
	Getter of mTolerateErrors.
static void	setTolerateErrors (const bool &tolerateerrors)
	Setter of mTolerateErrors.
Methods
virtual void	initialize ()
	Initialize X display.
virtual void	finalize ()
	Finalize X display.
virtual void	synchronize (const bool &discard=false)
	Flush the output buffer and then waits until all requests have been received and processed by the X server.
virtual s32	findBestVisual (const s32 &screenNumber, const s32 &multiSample=XDisplay::IGNOREMULTISAMPLE)
	Examine all visuals to find the so-called best one.
virtual void	getVisualAttribs (XVisualInfo *vInfo, VisualAttribs &attribs)
	Get visual attributes for the specified visual info descriptor.
virtual void	initializeMT ()
	Initialize X multithreading, enable Xlib support for concurrent threads.
Public Types
typedef Pointer< XDisplay, Mutex >	Pointer
	Type for pointer on this class.
Public Member Functions
Constructors & destructor
	XDisplay (const std::string &displayName="")
	Create an X display.
virtual	~XDisplay ()
	The destructor.
Static Public Attributes
Class constants
static const s32	IGNOREMULTISAMPLE = -1
	Constant for ignoring multisample.
static const s32	UNKNOWNDIMENSION = 0
	Constant for unknown display dimension.
Static Protected Member Functions
Class methods
static int	errorHandler (Display display, XErrorEvent errorEvent)
	X error handler.
Protected Attributes
Variables
std::string	mDisplayName
	X display name.
::Display *	mDisplay
	Wrapped X Display.
bool	mInitialized
	The display is initialized.
u32	mWidth
	Width of the display in pixels (of the default screen).
u32	mHeight
	Height of the display in pixels (of the default screen).
Static Protected Attributes
Class variables
static bool	mXMTInitialized = false
	X multithreading is initialized.
static bool	mXMTSupported = false
	X multithreading is supported.
static Mutex	mErrorHandlerMutex
	Mutex for synchronization the class level error handling.
static bool	mTolerateErrors = false
	Skip Xlib errors.
Classes
struct	VisualAttribs
	Struct for visual attributes. More...

Member Typedef Documentation

typedef Pointer< XDisplay, Mutex > ParCompMark::XDisplay::Pointer

Type for pointer on this class.

Definition at line 78 of file PCMXDisplay.h.

Constructor & Destructor Documentation

ParCompMark::XDisplay::XDisplay ( const std::string & displayName = "" )

Create an X display.

Parameters:

[in] displayName X display name

Definition at line 56 of file PCMXDisplay.cpp.

References ParCompMark::Singleton< T >::getInstance(), mDisplay, mDisplayName, mHeight, mInitialized, mWidth, ParCompMark::Logger::NOTICE, and UNKNOWNDIMENSION.

Here is the call graph for this function:

ParCompMark::XDisplay::~XDisplay ( ) [virtual]

The destructor.

This class has virtual destructor.

Definition at line 79 of file PCMXDisplay.cpp.

References finalize(), ParCompMark::Singleton< T >::getInstance(), mDisplayName, mInitialized, and ParCompMark::Logger::NOTICE.

Here is the call graph for this function:

Member Function Documentation

int ParCompMark::XDisplay::errorHandler	(	Display *	display,
		XErrorEvent *	errorEvent
	)			`[static, protected]`

X error handler.

Parameters:

`[in]`	display	X display
`[in]`	errorEvent	Error event

Returns:: Return code of the handler.

Definition at line 93 of file PCMXDisplay.cpp.

References Except, ParCompMark::Mutex::lock(), mErrorHandlerMutex, mTolerateErrors, ParCompMark::StringConverter::toString(), and ParCompMark::Mutex::unlock().

Referenced by initializeMT().

Here is the call graph for this function:

void ParCompMark::XDisplay::finalize ( ) [virtual]

Finalize X display.

Definition at line 163 of file PCMXDisplay.cpp.

References Assert, ParCompMark::Logger::DEBUG, ParCompMark::Singleton< T >::getInstance(), mDisplay, mDisplayName, mInitialized, and synchronize().

Referenced by ~XDisplay().

Here is the call graph for this function:

s32 ParCompMark::XDisplay::findBestVisual	(	const s32 &	screenNumber,
		const s32 &	multiSample = `XDisplay::IGNOREMULTISAMPLE`
	)			`[virtual]`

Examine all visuals to find the so-called best one.

We prefer deepest RGBA buffer with depth, stencil and accum that has no caveats. This will only choose formats with a multisample that equals multisample.

Parameters:

`[in]`	screenNumber	Screen number to test
`[in]`	multiSample	Select specific multisample value

Returns:: -1 in case of failure, otherwise a valid visual ID

Definition at line 190 of file PCMXDisplay.cpp.

Here is the call graph for this function:

inline::Display * ParCompMark::XDisplay::getDisplay ( ) const

Getter of mDisplay.

Returns value of mDisplay.

Returns:: The value of mDisplay

Definition at line 452 of file PCMXDisplay.h.

const std::string & ParCompMark::XDisplay::getDisplayName ( ) const [inline]

Getter of mDisplayName.

Returns value of mDisplayName.

Returns:: The value of mDisplayName

Definition at line 445 of file PCMXDisplay.h.

const Mutex & ParCompMark::XDisplay::getErrorHandlerMutex ( ) [inline, static]

Getter of mErrorHandlerMutex.

Returns value of mErrorHandlerMutex.

Returns:: The value of mErrorHandlerMutex

Definition at line 494 of file PCMXDisplay.h.

const u32 & ParCompMark::XDisplay::getHeight ( ) const [inline]

Getter of mHeight.

Returns value of mHeight.

Returns:: The value of mHeight

Definition at line 487 of file PCMXDisplay.h.

const bool & ParCompMark::XDisplay::getInitialized ( ) const [inline]

Getter of mInitialized.

Returns value of mInitialized.

Returns:: The value of mInitialized

Definition at line 459 of file PCMXDisplay.h.

const bool & ParCompMark::XDisplay::getTolerateErrors ( ) [inline, static]

Getter of mTolerateErrors.

Returns value of mTolerateErrors.

Returns:: The value of mTolerateErrors

Definition at line 501 of file PCMXDisplay.h.

void ParCompMark::XDisplay::getVisualAttribs	(	XVisualInfo *	vInfo,
		VisualAttribs &	attribs
	)			`[virtual]`

Get visual attributes for the specified visual info descriptor.

Parameters:

`[in]`	vInfo	Visual info descriptor
`[out]`	attribs	Variable to hold the restrieved attributes

Definition at line 263 of file PCMXDisplay.cpp.

Referenced by findBestVisual().

const u32 & ParCompMark::XDisplay::getWidth ( ) const [inline]

Getter of mWidth.

Returns value of mWidth.

Returns:: The value of mWidth

Definition at line 480 of file PCMXDisplay.h.

const bool & ParCompMark::XDisplay::getXMTInitialized ( ) [inline, static]

Getter of mXMTInitialized.

Returns value of mXMTInitialized.

Returns:: The value of mXMTInitialized

Definition at line 466 of file PCMXDisplay.h.

const bool & ParCompMark::XDisplay::getXMTSupported ( ) [inline, static]

Getter of mXMTSupported.

Returns value of mXMTSupported.

Returns:: The value of mXMTSupported

Definition at line 473 of file PCMXDisplay.h.

void ParCompMark::XDisplay::initialize ( ) [virtual]

Initialize X display.

Definition at line 132 of file PCMXDisplay.cpp.

References Assert, ParCompMark::Logger::DEBUG, ParCompMark::Singleton< T >::getInstance(), initializeMT(), mDisplay, mDisplayName, mHeight, mInitialized, mWidth, mXMTInitialized, and ParCompMark::StringConverter::toString().

Here is the call graph for this function:

void ParCompMark::XDisplay::initializeMT ( ) [protected, virtual]

Initialize X multithreading, enable Xlib support for concurrent threads.

This function must be the first Xlib function a multi-threaded program calls, and it must complete before any other Xlib call is made. (Internally called at the first XDisplay initialization.)

Definition at line 333 of file PCMXDisplay.cpp.

References errorHandler(), ParCompMark::Singleton< T >::getInstance(), mXMTInitialized, mXMTSupported, ParCompMark::Logger::NOTICE, and ParCompMark::Logger::WARNING.

Referenced by initialize().

Here is the call graph for this function: