eq::OSWindow Class Reference

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

#include <osWindow.h>

Inheritance diagram for eq::OSWindow:

[legend]

Collaboration diagram for eq::OSWindow:

[legend]

List of all members.

Public Member Functions
	OSWindow (Window *parent)
	Create a new OSWindow for the given eq::Window.
virtual	~OSWindow ()
	Destroy the OSWindow.
virtual void	queryDrawableConfig (DrawableConfig &drawableConfig)=0
	Set up _drawableConfig by querying the current context.
virtual GLEWContext *	glewGetContext ()
	Get the GLEW context for this window.
virtual const GLEWContext *	glewGetContext () const
Methods forwarded from eq::Window

virtual bool	configInit ()=0
	Initialize this OS window.
virtual void	configExit ()=0
	De-initialize this OS window.
virtual void	makeCurrent () const =0
	Make the OS window's rendering context and drawable current.
virtual void	bindFrameBuffer () const =0
	Bind the window's FBO, if it uses an FBO drawable.
virtual void	swapBuffers ()=0
	Swap the front and back buffer, for doublebuffered drawables.
virtual void	joinNVSwapBarrier (const uint32_t group, const uint32_t barrier)=0
	Join a NV_swap_group.
Frame Buffer Object support.

bool	configInitFBO ()
	Build and initialize the FBO.
void	configExitFBO ()
	Destroy FBO.
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
Protected Attributes
Window *const	_window
	The parent eq::Window.

Detailed Description

The interface definition for OS-specific windowing code.

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

Definition at line 40 of file osWindow.h.

Constructor & Destructor Documentation

eq::OSWindow::OSWindow ( Window * parent )

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

Definition at line 27 of file osWindow.cpp.

References _window.

eq::OSWindow::~OSWindow ( ) [virtual]

Destroy the OSWindow.

Definition at line 33 of file osWindow.cpp.

Member Function Documentation

virtual bool eq::OSWindow::configInit ( ) [pure virtual]

Initialize this OS 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.

Implemented in eq::AGLWindow, eq::GLXWindow, and eq::WGLWindow.

Referenced by eq::Window::configInitOSWindow().

Here is the caller graph for this function:

virtual void eq::OSWindow::configExit ( ) [pure virtual]

De-initialize this OS window.

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

Implemented in eq::AGLWindow, eq::GLXWindow, and eq::WGLWindow.

Referenced by eq::Window::configExitOSWindow().

Here is the caller graph for this function:

virtual void eq::OSWindow::makeCurrent ( ) const [pure virtual]

Make the OS window's 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.

Implemented in eq::AGLWindow, eq::GLWindow, eq::GLXWindow, and eq::WGLWindow.

Referenced by eq::Window::makeCurrent().

Here is the caller graph for this function:

virtual void eq::OSWindow::bindFrameBuffer ( ) const [pure virtual]

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

Implemented in eq::GLWindow.

Referenced by eq::Window::bindFrameBuffer().

Here is the caller graph for this function:

virtual void eq::OSWindow::swapBuffers ( ) [pure virtual]

Swap the front and back buffer, for doublebuffered drawables.

Implemented in eq::AGLWindow, eq::GLXWindow, and eq::WGLWindow.

Referenced by eq::Window::swapBuffers().

Here is the caller graph for this function:

virtual void eq::OSWindow::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.

Implemented in eq::AGLWindow, eq::GLXWindow, and eq::WGLWindow.

bool eq::OSWindow::configInitFBO ( )

Build and initialize the FBO.

Reimplemented in eq::GLWindow.

void eq::OSWindow::configExitFBO ( )

Destroy FBO.

Reimplemented in eq::GLWindow.

virtual const util::FrameBufferObject* eq::OSWindow::getFrameBufferObject ( ) const [inline, virtual]

Returns:: the FBO of this window, or 0 if no FBO is used.

Reimplemented in eq::GLWindow.

Definition at line 108 of file osWindow.h.

Referenced by eq::Channel::applyBuffer().

Here is the caller graph for this function:

virtual void eq::OSWindow::queryDrawableConfig ( DrawableConfig & drawableConfig ) [pure virtual]

Set up _drawableConfig by querying the current context.

Implemented in eq::GLWindow.

Referenced by eq::Window::setOSWindow().

Here is the caller graph for this function:

virtual GLEWContext* eq::OSWindow::glewGetContext ( ) [inline, virtual]

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