A channel represents a two-dimensional viewport within a Window. More...

#include <channel.h>

Inheritance diagram for eq::Channel:

Collaboration diagram for eq::Channel:

Classes
struct	FrameStatistics
Public Member Functions
	Channel (Window *parent)
	Construct a new channel.
virtual	~Channel ()
	Destruct the channel.
virtual bool	processEvent (const Event &event)
	Process a received event.
virtual void	drawStatistics ()
	Draw a statistics overlay.
virtual void	outlineViewport ()
	Outline the current pixel viewport.
void	changeLatency (const uint32_t latency)
const Vector3ub &	getUniqueColor () const
Data Access
co::CommandQueue *	getPipeThreadQueue ()
co::CommandQueue *	getCommandThreadQueue ()
bool	isStopped () const
Pipe *	getPipe ()
const Pipe *	getPipe () const
Node *	getNode ()
const Node *	getNode () const
Config *	getConfig ()
const Config *	getConfig () const
ServerPtr	getServer ()
const GLEWContext *	glewGetContext () const
	Get the GLEW context for this channel.
ObjectManager *	getObjectManager ()
const DrawableConfig &	getDrawableConfig () const
View *	getNativeView ()
	Get the channel's native view.
const View *	getNativeView () const
	const-version of getNativeView()
util::FrameBufferObject *	getFrameBufferObject ()
void	addStatistic (Event &event, const uint32_t index)
Context-specific data access.
The data returned by these methods depends on the context (callback) they are called from, typically the data for the current rendering task. If they are called outside of a frame task method, they return the channel's native parameter or a placeholder value for the task decomposition parameters.
virtual Vector2f	getJitter () const
const Frames &	getInputFrames ()
const Frames &	getOutputFrames ()
View *	getView ()
	Get the channel's current View.
const View *	getView () const
	Const version of getView().
Frustumf	getScreenFrustum () const
	Returns an orthographic frustum for 2D operations on the view.
Operations
Operations are only meaningful from within certain callbacks. They are just convenience wrappers applying context-specific data to the OpenGL state using the context-specific data access above.
virtual void	applyBuffer ()
	Apply the current rendering buffer, including the color mask.
virtual void	applyColorMask () const
	Apply the current color mask.
virtual void	applyViewport () const
	Apply the OpenGL viewport for the current rendering task.
virtual void	applyFrustum () const
	Apply the frustum matrix for the current rendering task.
virtual void	applyPerspective () const
	Apply the perspective frustum matrix for the current rendering task.
virtual void	applyOrtho () const
	Apply the orthographic frustum matrix for the current rendering task.
void	applyScreenFrustum () const
	Apply an orthographic frustum for pixel-based 2D operations.
virtual void	applyHeadTransform () const
	Apply the transformation to position the view frustum.
virtual void	applyPerspectiveTransform () const
	Apply the transformation to position the perspective view frustum.
virtual void	applyOrthoTransform () const
	Apply the transformation to position the orthographic view frustum.
virtual void	applyFrameBufferObject ()
	Apply the current alternate frame buffer.
void	bindFrameBuffer ()
	Rebind the current alternate FBO of the channel or window.
Protected Member Functions
void	attach (const UUID &id, const uint32_t instanceID)
virtual void	notifyViewportChanged ()
	Notification that parameters influencing the vp/pvp have changed.
virtual void	notifyStopFrame (const uint32_t lastFrameNumber)
	Notify interruption of the rendering.
Actions
void	startFrame (const uint32_t frameNumber)
	Start a frame by unlocking all child resources.
void	releaseFrame (const uint32_t frameNumber)
	Signal the completion of a frame to the parent.
void	releaseFrameLocal (const uint32_t frameNumber)
	Release the local synchronization of the parent for a frame.
virtual void	setupAssemblyState ()
	Setup the OpenGL state for a readback or assemble operation.
virtual void	resetAssemblyState ()
	Reset the OpenGL state after an assembly operation.
Task Methods
The task methods (callbacks) are called by Equalizer during rendering to execute various rendering tasks. Each task method has a useful default implementation, but at least frameDraw() is implemented by an application.
virtual bool	configInit (const uint128_t &initID)
	Initialize this channel.
virtual bool	configExit ()
	Exit this channel.
virtual void	frameStart (const uint128_t &frameID, const uint32_t frameNumber)
	Start rendering a frame.
virtual void	frameFinish (const uint128_t &frameID, const uint32_t frameNumber)
	Finish rendering a frame.
virtual void	frameDrawFinish (const uint128_t &frameID, const uint32_t frameNumber)
	Finish drawing.
virtual void	frameClear (const uint128_t &frameID)
	Clear the frame buffer.
virtual void	frameDraw (const uint128_t &frameID)
	Draw the scene.
virtual void	frameAssemble (const uint128_t &frameID)
	Assemble all input frames.
virtual void	frameReadback (const uint128_t &frameID)
	Read back the rendered frame buffer into all output frames.
virtual void	frameViewStart (const uint128_t &frameID)
	Start updating a destination channel.
virtual void	frameViewFinish (const uint128_t &frameID)
	Finish updating a destination channel.
Friends
class	fabric::Window< Pipe, Window, Channel >
class	ChannelStatistics

Detailed Description

A channel represents a two-dimensional viewport within a Window.

The channel is the basic rendering entity. It represents a 2D rendering area within a Window. It executes all rendering-relevant tasks, such as clear, draw, assemble and readback. Each rendering task is using its own RenderContext, which is computed by the server based on the rendering description of the current configuration.

See also:: fabric::Channel

Definition at line 44 of file include/eq/channel.h.

Constructor & Destructor Documentation

eq::Channel::Channel ( Window * parent )

Construct a new channel.

Version:: 1.0

Reimplemented in eqHello::Channel, eqNbody::Channel, eqPixelBench::Channel, eqPly::Channel, eVolve::Channel, and osgScaleViewer::Channel.

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

Destruct the channel.

Version:: 1.0

Reimplemented from eq::fabric::Channel< Window, Channel >.

Reimplemented in eqNbody::Channel, eqPixelBench::Channel, eqPly::Channel, and eVolve::Channel.

Member Function Documentation

virtual void eq::Channel::applyBuffer ( ) [virtual]

Apply the current rendering buffer, including the color mask.

See also:: getReadBuffer() , getDrawBuffer(), getDrawBufferMask()

Version:: 1.0

Referenced by eqPly::Channel::frameAssemble(), eqPly::Channel::frameClear(), eVolve::Channel::frameStart(), and eqPly::Channel::frameViewFinish().

Here is the caller graph for this function:

virtual void eq::Channel::applyColorMask ( ) const [virtual]

Apply the current color mask.

See also:: applyBuffer(), getDrawBufferMask()

Version:: 1.0

virtual void eq::Channel::applyFrameBufferObject ( ) [virtual]

Apply the current alternate frame buffer.

Version:: 1.0

virtual void eq::Channel::applyFrustum ( ) const [virtual]

Apply the frustum matrix for the current rendering task.

If a sub-pixel decomposition is defined, the frustum is jittered by the amount given by getJitter() to implement software anti-aliasing. Applications which want to implement a different multi-sampling algorithm, e.g., depth-of-field, have to re-implement getJitter() or applyFrustum() accordingly.

See also:: useOrtho(), getJitter(), getSubPixel()

Version:: 1.0

virtual void eq::Channel::applyHeadTransform ( ) const [virtual]

Apply the transformation to position the view frustum.

Version:: 1.0

See also:: useOrtho()

virtual void eq::Channel::applyOrtho ( ) const [virtual]

Apply the orthographic frustum matrix for the current rendering task.

Version:: 1.0

virtual void eq::Channel::applyOrthoTransform ( ) const [virtual]

Apply the transformation to position the orthographic view frustum.

Version:: 1.0

virtual void eq::Channel::applyPerspective ( ) const [virtual]

Apply the perspective frustum matrix for the current rendering task.

Version:: 1.0

virtual void eq::Channel::applyPerspectiveTransform ( ) const [virtual]

Apply the transformation to position the perspective view frustum.

Version:: 1.0

void eq::Channel::applyScreenFrustum ( ) const

Apply an orthographic frustum for pixel-based 2D operations.

One unit of the frustum covers one pixel on screen. The frustum is positioned relative to the view.

Version:: 1.0

Referenced by eVolve::Channel::frameViewFinish().

Here is the caller graph for this function:

virtual void eq::Channel::applyViewport ( ) const [virtual]

Apply the OpenGL viewport for the current rendering task.

See also:: getViewport()

Version:: 1.0

Referenced by eqPly::Channel::frameAssemble(), eqPly::Channel::frameClear(), eVolve::Channel::frameStart(), and eqPly::Channel::frameViewFinish().

Here is the caller graph for this function:

void eq::Channel::bindFrameBuffer ( )

Rebind the current alternate FBO of the channel or window.

Version:: 1.0

virtual bool eq::Channel::configExit ( ) [protected, virtual]

Exit this channel.

Version:: 1.0

Reimplemented in eqPly::Channel.

virtual bool eq::Channel::configInit ( const uint128_t & initID ) [protected, virtual]

Initialize this channel.

Parameters:

initID the init identifier.

Version:: 1.0

Reimplemented in eqNbody::Channel, eqPly::Channel, and eVolve::Channel.

Referenced by eqPly::Channel::configInit(), and eqNbody::Channel::configInit().

Here is the caller graph for this function:

virtual void eq::Channel::drawStatistics ( ) [virtual]

Draw a statistics overlay.

Version:: 1.0

Referenced by eqPly::Channel::frameViewFinish().

Here is the caller graph for this function:

virtual void eq::Channel::frameAssemble ( const uint128_t & frameID ) [protected, virtual]

Assemble all input frames.

Called 0 to n times during one frame.

Parameters:

frameID the per-frame identifier.

See also:: getInputFrames()

Version:: 1.0

Reimplemented in eqPly::Channel, and eVolve::Channel.

virtual void eq::Channel::frameClear ( const uint128_t & frameID ) [protected, virtual]

Clear the frame buffer.

Called 0 to n times during one frame.

Parameters:

frameID the per-frame identifier.

Version:: 1.0

Reimplemented in eqPly::Channel, eVolve::Channel, and osgScaleViewer::Channel.

virtual void eq::Channel::frameDraw ( const uint128_t & frameID ) [protected, virtual]

Draw the scene.

Called 0 to n times during one frame.

Parameters:

frameID the per-frame identifier.

Version:: 1.0

Reimplemented in eqHello::Channel, eqNbody::Channel, eqPixelBench::Channel, eqPly::Channel, eVolve::Channel, and osgScaleViewer::Channel.

Referenced by eqHello::Channel::frameDraw().

Here is the caller graph for this function:

virtual void eq::Channel::frameDrawFinish	(	const uint128_t &	frameID,
		const uint32_t	frameNumber
	)		`[protected, virtual]`

Finish drawing.

Called once per frame after the last draw operation. Typically releases the local node thread synchronization for this frame.

Parameters:

frameID	the per-frame identifier.
frameNumber	the frame to finished with draw.

Version:: 1.0

virtual void eq::Channel::frameFinish	(	const uint128_t &	frameID,
		const uint32_t	frameNumber
	)		`[protected, virtual]`

Finish rendering a frame.

Called once at the end of each frame, to do per-frame updates of channel-specific data. This method has to call releaseFrame().

Parameters:

frameID	the per-frame identifier.
frameNumber	the frame to finish.

Version:: 1.0

Reimplemented in eqPly::Channel.

virtual void eq::Channel::frameReadback ( const uint128_t & frameID ) [protected, virtual]

Read back the rendered frame buffer into all output frames.

Called 0 to n times during one frame.

Parameters:

frameID the per-frame identifier.

See also:: getOutputFrames()

Version:: 1.0

Reimplemented in eqPly::Channel, and eVolve::Channel.

virtual void eq::Channel::frameStart	(	const uint128_t &	frameID,
		const uint32_t	frameNumber
	)		`[protected, virtual]`

Start rendering a frame.

Called once at the beginning of each frame, to do per-frame updates of channel-specific data. This method has to call startFrame().

Parameters:

frameID	the per-frame identifier.
frameNumber	the frame to start.

See also:: Config::startFrame()

Version:: 1.0

Reimplemented in eqPixelBench::Channel, eqPly::Channel, and eVolve::Channel.

virtual void eq::Channel::frameViewFinish ( const uint128_t & frameID ) [protected, virtual]

Finish updating a destination channel.

Called once on each destination channel, e.g., channels which are defined by a view/segment intersection, before frameFinish to update a part of a view.

This is typically used to do operations on the output channel after it has been fully updated, e.g., to draw a 2D overlay.

Parameters:

frameID the per-frame identifier.

Version:: 1.0

Reimplemented in eqPly::Channel, eVolve::Channel, and osgScaleViewer::Channel.

virtual void eq::Channel::frameViewStart ( const uint128_t & frameID ) [protected, virtual]

Start updating a destination channel.

Called once on each destination channel, e.g., channels which are defined by a view/segment intersection, after frameStart to update a part of a display.

Parameters:

frameID the per-frame identifier.

Version:: 1.0

Reimplemented in eqPly::Channel.

Config* eq::Channel::getConfig ( )

Returns:: the parent config.

Version:: 1.0

Referenced by eqNbody::Channel::configInit(), and eqPly::Channel::frameViewFinish().

Here is the caller graph for this function:

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

Returns:: the parent config.

Version:: 1.0

const DrawableConfig& eq::Channel::getDrawableConfig ( ) const

Returns:: the channel's drawable config.

Version:: 1.0

util::FrameBufferObject* eq::Channel::getFrameBufferObject ( )

Returns:: the FBO used as an alternate frame buffer.

Version:: 1.0

const Frames& eq::Channel::getInputFrames ( ) [inline]

Returns:: the list of input frames, used from frameAssemble().

Version:: 1.0

Definition at line 150 of file include/eq/channel.h.

Referenced by eqPly::Channel::frameAssemble().

Here is the caller graph for this function:

virtual Vector2f eq::Channel::getJitter ( ) const [virtual]

Returns:: the jitter vector for the current subpixel decomposition.

Version:: 1.0

Reimplemented in eqPly::Channel.

Referenced by eqPly::Channel::getJitter().

Here is the caller graph for this function:

View* eq::Channel::getNativeView ( )

Get the channel's native view.

This function always returns the channel's native view, no matter in which context it is called. Only destination channels have a native view.

Returns:: the channel's native view, or 0 if it does not have one.

See also:: getView()

Version:: 1.0

const View* eq::Channel::getNativeView ( ) const

const-version of getNativeView()

Version:: 1.0

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

Returns:: the parent node.

Version:: 1.0

Node* eq::Channel::getNode ( )

Returns:: the parent node.

Version:: 1.0

ObjectManager* eq::Channel::getObjectManager ( )

Returns:: the window's object manager instance.

Version:: 1.0

const Frames& eq::Channel::getOutputFrames ( ) [inline]

Returns:: the list of output frames, used from frameReadback().

Version:: 1.0

Definition at line 156 of file include/eq/channel.h.

Referenced by eqPly::Channel::frameReadback().

Here is the caller graph for this function:

Pipe* eq::Channel::getPipe ( )

Returns:: the parent pipe.

Version:: 1.0

Referenced by eqNbody::Channel::configInit(), eqNbody::Channel::frameDraw(), and eVolve::Channel::useOrtho().

Here is the caller graph for this function:

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

Returns:: the parent pipe.

Version:: 1.0

Frustumf eq::Channel::getScreenFrustum ( ) const

Returns an orthographic frustum for 2D operations on the view.

One unit of the frustum covers one pixel on screen. The frustum is positioned relative to the view.

Returns:: the 2D orthographic frustum.

Version:: 1.0

ServerPtr eq::Channel::getServer ( )

Returns:: the parent server.

Version:: 1.0

const Vector3ub& eq::Channel::getUniqueColor ( ) const [inline]

Returns:: a fixed unique color for this channel.

Version:: 1.0

Definition at line 312 of file include/eq/channel.h.

Referenced by eVolve::Channel::configInit(), eqPly::Channel::frameClear(), and eqPly::Channel::frameDraw().

Here is the caller graph for this function:

View* eq::Channel::getView ( )

Get the channel's current View.

During a frame task method, i.e., in one of the frameFoo functions, the view is set to the view of the destination channel, that is, the channel for which this channel is executing the rendering task. Outside of a frame task method the native view of the channel, or 0, is returned.

Returns:: the channel's view, or 0 if it does not have a view.

See also:: getNativeView()

Version:: 1.0

Referenced by eqPly::Channel::frameClear(), eqPly::Channel::frameViewFinish(), and eqPly::Channel::getJitter().

Here is the caller graph for this function:

const View* eq::Channel::getView ( ) const

Const version of getView().

Version:: 1.0

const GLEWContext* eq::Channel::glewGetContext ( ) const

Get the GLEW context for this channel.

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

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

Version:: 1.0

Referenced by eqNbody::Channel::Channel().

Here is the caller graph for this function:

bool eq::Channel::isStopped ( ) const [inline]

Returns:: true if this channel is stopped, false otherwise.

Version:: 1.0

Definition at line 62 of file include/eq/channel.h.

virtual void eq::Channel::notifyStopFrame ( const uint32_t lastFrameNumber ) [inline, protected, virtual]

Notify interruption of the rendering.

This method is called from the Client command thread, as opposed to the rendering thread. Its purpose is to cause the rendering thread to stop its operations as soon as possible. Normal rendering shall recommence after the given frame.

Parameters:

lastFrameNumber stop rendering until this frame has been processed.

Version:: 1.0

Reimplemented in eqPly::Channel.

Definition at line 505 of file include/eq/channel.h.

virtual void eq::Channel::notifyViewportChanged ( ) [protected, virtual]

Notification that parameters influencing the vp/pvp have changed.

Reimplemented from eq::fabric::Channel< Window, Channel >.

virtual void eq::Channel::outlineViewport ( ) [virtual]

Outline the current pixel viewport.

Version:: 1.0

Referenced by eqNbody::Channel::frameDraw().

Here is the caller graph for this function:

virtual bool eq::Channel::processEvent ( const Event & event ) [virtual]

Process a received event.

The task of this method is to update the channel as necessary, and transform the event into an config event to be send to the application using Config::sendEvent().

Parameters:

event the received event.

Returns:: true when the event was handled, false if not.

Version:: 1.0

void eq::Channel::releaseFrame ( const uint32_t frameNumber ) [protected]

Signal the completion of a frame to the parent.

Parameters:

frameNumber the frame to end.

Version:: 1.0

void eq::Channel::releaseFrameLocal ( const uint32_t frameNumber ) [protected]

Release the local synchronization of the parent for a frame.

Parameters:

frameNumber the frame to release.

Version:: 1.0

virtual void eq::Channel::resetAssemblyState ( ) [protected, virtual]

Reset the OpenGL state after an assembly operation.

Version:: 1.0

Referenced by eqPly::Channel::frameAssemble(), and eqPly::Channel::frameViewFinish().

Here is the caller graph for this function:

virtual void eq::Channel::setupAssemblyState ( ) [protected, virtual]

Setup the OpenGL state for a readback or assemble operation.

The default implementation is very conservative and saves any state which is potentially changed by the assembly routines. Applications may overwrite this and resetAssemblyState() to optimize performance in accordance with their rendering code.