eq::OSPipe Class Reference

The interface definition for OS-specific GPU handling. More...

#include <osPipe.h>

Inheritance diagram for eq::OSPipe:

[legend]

Collaboration diagram for eq::OSPipe:

[legend]

List of all members.

Public Member Functions
	OSPipe (Pipe *parent)
	Create a new OSPipe for the given eq::Pipe.
virtual	~OSPipe ()
	Destroy the OSPipe.
const std::string &	getErrorMessage () const
Pipe *	getPipe ()
const Pipe *	getPipe () const
Methods forwarded from eq::Pipe
virtual bool	configInit ()=0
	Initialize the GPU.
virtual void	configExit ()=0
	De-initialize the GPU.
Protected Member Functions
Error information.
void	setErrorMessage (const std::string &message)
	Set a message why the last operation failed.
Protected Attributes
Pipe *const	_pipe
	The parent eq::Pipe.
std::string	_error
	The reason for the last error.

---

Detailed Description

The interface definition for OS-specific GPU handling.

The OSPipe abstracts all OS-system specific code for handling a GPU, which facilitates porting to new windowing systems. Each Pipe uses one OSPipe, which is initialized in Pipe::configInit. The OSPipe has to set the pipe's PixelViewport if it is invalid during configInit().

Definition at line 37 of file osPipe.h.

---

Constructor & Destructor Documentation

eq::OSPipe::OSPipe

(

Pipe *

parent

)

Create a new OSPipe for the given eq::Pipe.

Definition at line 25 of file osPipe.cpp.

References _pipe.

eq::OSPipe::~OSPipe

(

)

[virtual]

Destroy the OSPipe.

Definition at line 31 of file osPipe.cpp.

---

Member Function Documentation

virtual bool eq::OSPipe::configInit

(

)

[pure virtual]

Initialize the GPU.

Implemented in eq::AGLPipe, eq::GLXPipe, and eq::WGLPipe.

Referenced by eq::Pipe::configInit().

Here is the caller graph for this function:

virtual void eq::OSPipe::configExit

(

)

[pure virtual]

De-initialize the GPU.

Implemented in eq::AGLPipe, eq::GLXPipe, and eq::WGLPipe.

Referenced by eq::Pipe::configExit().

Here is the caller graph for this function:

const std::string& eq::OSPipe::getErrorMessage

(

)

const [inline]

Returns:

the reason of the last failed operation.

Definition at line 56 of file osPipe.h.

Referenced by eq::Pipe::configInit().

Here is the caller graph for this function:

Pipe* eq::OSPipe::getPipe

(

)

[inline]

Returns:

the parent Pipe.

Definition at line 59 of file osPipe.h.

const Pipe* eq::OSPipe::getPipe

(

)

const [inline]

Returns:

the parent Pipe.

Definition at line 62 of file osPipe.h.

void eq::OSPipe::setErrorMessage

(

const std::string &

message

)

[inline, protected]

Set a message why the last operation failed.

The message will be transmitted to the originator of the request, for example to Config::init when set from within the configInit method.

Parameters:

message

the error message.

Definition at line 75 of file osPipe.h.

Referenced by eq::GLXPipe::configInit(), eq::AGLPipe::configInit(), and eq::WGLPipe::createWGLAffinityDC().

Here is the caller graph for this function:

---

Member Data Documentation

Pipe* const eq::OSPipe::_pipe [protected]

The parent eq::Pipe.

Definition at line 79 of file osPipe.h.

Referenced by eq::WGLPipe::configExit(), eq::WGLPipe::configInit(), eq::GLXPipe::configInit(), eq::AGLPipe::configInit(), eq::WGLPipe::createWGLDisplayDC(), and OSPipe().

std::string eq::OSPipe::_error [protected]

The reason for the last error.

Definition at line 82 of file osPipe.h.

---

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

• osPipe.h
• osPipe.cpp