The interface definition for system-specific windowing code. More...

#include <systemWindow.h>

Inheritance diagram for eq::SystemWindow:

Collaboration diagram for eq::SystemWindow:

Public Member Functions
	SystemWindow (Window *parent)
	Create a new SystemWindow for the given eq::Window. More...

virtual	~SystemWindow ()
	Destroy the SystemWindow. More...

virtual void	queryDrawableConfig (DrawableConfig &dc)=0
	Set up the given drawable based on the current context. More...

virtual const GLEWContext *	glewGetContext () const
	Get the GLEW context for this window. More...

void	setError (const int32_t error)
	Set an error code why the last operation failed. More...

eq::fabric::Error	getError () const

virtual bool	processEvent (const Event &event)
	Process an event. More...

Methods forwarded from eq::Window
virtual bool	configInit ()=0
	Initialize this system window. More...

virtual void	configExit ()=0
	De-initialize this system window. More...

virtual void	makeCurrent (const bool cache=true) const =0
	Make the system window rendering context and drawable current. More...

virtual void	bindFrameBuffer () const =0
	Bind the window's FBO, if it uses an FBO drawable. More...

virtual void	swapBuffers ()=0
	Swap the front and back buffer. More...

virtual void	flush ()=0
	Flush all command buffers. More...

virtual void	finish ()=0
	Finish execution of all commands. More...

virtual void	joinNVSwapBarrier (const uint32_t group, const uint32_t barrier)=0
	Join a NV_swap_group. More...

Frame Buffer Object support.
bool	configInitFBO ()
	Build and initialize the FBO. More...

void	configExitFBO ()
	Destroy FBO. More...

virtual const util::FrameBufferObject *	getFrameBufferObject () const

Convenience interface to eq::Window methods
Window *	getWindow ()

const Window *	getWindow () const

Pipe *	getPipe ()

const Pipe *	getPipe () const

Node *	getNode ()

const Node *	getNode () const

Config *	getConfig ()

const Config *	getConfig () const

int32_t	getIAttribute (const Window::IAttribute attr) const

Detailed Description

The interface definition for system-specific windowing code.

The system window abstracts all window system specific code and facilitates porting to new windowing systems. Each eq::Window uses one eq::SystemWindow, which is created and initialized in Window::configInitSystemWindow.

Definition at line 35 of file systemWindow.h.

Constructor & Destructor Documentation

eq::SystemWindow::SystemWindow ( Window * parent )

Create a new SystemWindow for the given eq::Window.

Version: 1.0

virtual eq::SystemWindow::~SystemWindow ( )

virtual

Destroy the SystemWindow.

Version: 1.0

Member Function Documentation

virtual void eq::SystemWindow::bindFrameBuffer ( ) const

pure virtual

Bind the window's FBO, if it uses an FBO drawable.

Version: 1.0

Implemented in eq::GLWindow.

virtual void eq::SystemWindow::configExit ( )

pure virtual

De-initialize this system window.

This function might be called on partially or uninitialized system windows, and the implemenation has therefore be tolerant enough to handle this case.

Version: 1.0

Implemented in eq::wgl::Window, eq::agl::Window, and eq::glx::Window.

void eq::SystemWindow::configExitFBO ( )

Destroy FBO.

Version: 1.0

virtual bool eq::SystemWindow::configInit ( )

pure virtual

Initialize this system window.

This method should take into account all attributes of the parent Window.

Returns: true if the window was correctly initialized, false on any error.

Version: 1.0

Implemented in eq::wgl::Window, eq::agl::Window, and eq::glx::Window.

bool eq::SystemWindow::configInitFBO ( )

Build and initialize the FBO.

Version: 1.0

virtual void eq::SystemWindow::finish ( )

pure virtual

Finish execution of all commands.

Version: 1.5.2

Implemented in eq::GLWindow.

virtual void eq::SystemWindow::flush ( )

pure virtual

Flush all command buffers.

Version: 1.5.2

Implemented in eq::GLWindow.

Config* eq::SystemWindow::getConfig ( )

Returns: the parent config.

Version: 1.0

const Config* eq::SystemWindow::getConfig ( ) const

Returns: the parent config.

Version: 1.0

eq::fabric::Error eq::SystemWindow::getError ( ) const

Returns: the error from the last failed operation.

Version: 1.0

virtual const util::FrameBufferObject* eq::SystemWindow::getFrameBufferObject ( ) const

inlinevirtual

Returns: the FBO of this window, or 0.

Version: 1.0

Reimplemented in eq::GLWindow.

Definition at line 113 of file systemWindow.h.

int32_t eq::SystemWindow::getIAttribute ( const Window::IAttribute attr ) const

Returns: an integer attribute of the parent window.

Version: 1.0

Node* eq::SystemWindow::getNode ( )

Returns: the parent node.

Version: 1.0

const Node* eq::SystemWindow::getNode ( ) const

Returns: the parent node.

Version: 1.0

Pipe* eq::SystemWindow::getPipe ( )

Returns: the parent pipe.

Version: 1.0

const Pipe* eq::SystemWindow::getPipe ( ) const

Returns: the parent pipe.

Version: 1.0

Window* eq::SystemWindow::getWindow ( )

inline

Returns: the parent window.

Version: 1.0

Definition at line 120 of file systemWindow.h.

const Window* eq::SystemWindow::getWindow ( ) const

inline

Returns: the parent window.

Version: 1.0

Definition at line 123 of file systemWindow.h.

virtual const GLEWContext* eq::SystemWindow::glewGetContext ( ) const

inlinevirtual

Get the GLEW context for this window.

The glew context is initialized during window initialization, and provides access to OpenGL extensions. This function does not follow the Equalizer naming conventions, since GLEW uses a function of this name to automatically resolve OpenGL function entry points. Therefore, any supported GL function can be called directly from an initialized SystemWindow.

Returns: the extended OpenGL function table for the window's OpenGL context.

Version: 1.0

Reimplemented in eq::GLWindow.

Definition at line 167 of file systemWindow.h.

virtual void eq::SystemWindow::joinNVSwapBarrier	(	const uint32_t	group,
		const uint32_t	barrier
	)

pure virtual

Join a NV_swap_group.

See WGL or GLX implementation and OpenGL extension for details on how to implement this function.

Parameters

group	the swap group name.
barrier	the swap barrier name.

Version: 1.0

Implemented in eq::wgl::Window, eq::agl::Window, and eq::glx::Window.

virtual void eq::SystemWindow::makeCurrent ( const bool cache = true ) const

pure virtual

Make the system window rendering context and drawable current.

This function invalidates the pipe's make current cache. If this function is not called, Pipe::setCurrent() has to be called appropriately.

Version: 1.0

Implemented in eq::wgl::Window, eq::agl::Window, eq::glx::Window, and eq::GLWindow.

virtual bool eq::SystemWindow::processEvent ( const Event & event )

virtual

Process an event.

Version: 1.0

virtual void eq::SystemWindow::queryDrawableConfig ( DrawableConfig & dc )

pure virtual

Set up the given drawable based on the current context.

Version: 1.0

Implemented in eq::GLWindow.

void eq::SystemWindow::setError ( const int32_t error )

Set an error code why the last operation failed.

The error will be set on the parent window.

Parameters

error the error message.

Version: 1.0

virtual void eq::SystemWindow::swapBuffers ( )

pure virtual

Swap the front and back buffer.

Version: 1.0

Implemented in eq::wgl::Window, eq::agl::Window, and eq::glx::Window.

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

systemWindow.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation