eq::OSPipe Class Reference

The interface definition for OS-specific pipe code. 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)
const std::string &	getErrorMessage () const
Pipe *	getPipe ()
const Pipe *	getPipe () const
WGLEWContext *	wglewGetContext ()
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.
WGLEWContext *	_wglewContext
	Extended OpenGL function entries - WGL.
union {
char   dummy [64]
};

---

Detailed Description

The interface definition for OS-specific pipe code.

The OSPipe abstracts all pipe system specific code and facilitates porting to new windowing systems. Each Pipe uses one OSPipe, which is initialized in Pipe::configInitOSPipe.

Definition at line 38 of file osPipe.h.

---

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 error.

Definition at line 54 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 57 of file osPipe.h.

const Pipe* eq::OSPipe::getPipe

(

)

const [inline]

Returns:

the parent Pipe.

Definition at line 60 of file osPipe.h.

WGLEWContext* eq::OSPipe::wglewGetContext

(

)

[inline]

Returns:

the generic WGL function table for the pipe.

Definition at line 63 of file osPipe.h.

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

Here is the caller graph for this function:

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 76 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 80 of file osPipe.h.

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

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

The reason for the last error.

Definition at line 83 of file osPipe.h.

WGLEWContext* eq::OSPipe::_wglewContext [protected]

Extended OpenGL function entries - WGL.

Definition at line 86 of file osPipe.h.

---

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

• osPipe.h
• osPipe.cpp