eqPly::Channel Class Reference

The rendering entity, updating a part of a Window. More...

#include <channel.h>

Inheritance diagram for eqPly::Channel:

[legend]

Collaboration diagram for eqPly::Channel:

[legend]

List of all members.

Classes
struct	Accum
Public Member Functions
	Channel (eq::Window *parent)
	Construct a new channel.
Protected Member Functions
virtual	~Channel ()
	Destruct the channel.
virtual bool	configInit (const uint32_t initID)
	Initialize this channel.
virtual bool	configExit ()
	Exit this channel.
virtual void	frameClear (const uint32_t frameID)
	Clear the frame buffer.
virtual void	frameDraw (const uint32_t frameID)
	Draw the scene.
virtual void	frameAssemble (const uint32_t frameID)
	Assemble input frames.
virtual void	frameReadback (const uint32_t frameID)
	Read back the rendered scene.
virtual void	frameStart (const uint32_t frameID, const uint32_t frameNumber)
	Start rendering a frame.
virtual void	frameFinish (const uint32_t frameID, const uint32_t frameNumber)
	Finish rendering a frame.
virtual void	frameViewStart (const uint32_t frameID)
	Start updating a destination channel.
virtual void	frameViewFinish (const uint32_t frameID)
	Finish updating a destination channel.
virtual void	applyFrustum () const
	Applies the perspective or orthographic frustum.

Detailed Description

The rendering entity, updating a part of a Window.

Definition at line 49 of file examples/eqPly/channel.h.

Constructor & Destructor Documentation

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

Construct a new channel.

Reimplemented from eq::Channel.

Definition at line 48 of file examples/eqPly/channel.cpp.

virtual eqPly::Channel::~Channel ( ) [inline, protected, virtual]

Destruct the channel.

Reimplemented from eq::Channel.

Definition at line 55 of file examples/eqPly/channel.h.

Member Function Documentation

bool eqPly::Channel::configInit ( const uint32_t initID ) [protected, virtual]

Initialize this channel.

Parameters:

initID

the init identifier.

Reimplemented from eq::Channel.

Definition at line 55 of file examples/eqPly/channel.cpp.

References eq::Channel::configInit(), EQINFO, eq::net::Object::getID(), eq::Channel::getName(), and eq::Channel::setNearFar().

Here is the call graph for this function:

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

Exit this channel.

Reimplemented from eq::Channel.

Definition at line 67 of file examples/eqPly/channel.cpp.

void eqPly::Channel::frameClear ( const uint32_t frameID ) [protected, virtual]

Clear the frame buffer.

Called 0 to n times during one frame.

Parameters:

frameID

the per-frame identifier.

Reimplemented from eq::Channel.

Definition at line 78 of file examples/eqPly/channel.cpp.

References eq::Channel::applyBuffer(), eq::Channel::applyViewport(), eq::Channel::getEye(), eq::net::Object::getID(), eq::Channel::getUniqueColor(), and eq::Channel::getView().

Here is the call graph for this function:

void eqPly::Channel::frameDraw ( const uint32_t frameID ) [protected, virtual]

Draw the scene.

Called 0 to n times during one frame.

Parameters:

frameID

the per-frame identifier.

Reimplemented from eq::Channel.

Definition at line 106 of file examples/eqPly/channel.cpp.

References eqPly::COLOR_DEMO, EQ_MAX, eq::Channel::getEye(), eq::Channel::getPeriod(), eq::Channel::getSubPixel(), and eq::Channel::getUniqueColor().

Here is the call graph for this function:

void eqPly::Channel::frameAssemble ( const uint32_t frameID ) [protected, virtual]

Assemble input frames.

Called 0 to n times during one frame.

Parameters:

frameID

the per-frame identifier.

See also:: getInputFrames

Reimplemented from eq::Channel.

Definition at line 168 of file examples/eqPly/channel.cpp.

References eq::Channel::applyBuffer(), eq::Channel::applyViewport(), eq::Compositor::assembleFrames(), EQ_MAX, EQWARN, eq::Channel::getEye(), eq::Channel::getInputFrames(), eq::Frame::getPeriod(), eq::Channel::getPixelViewport(), eq::Frame::getSubPixel(), eq::Channel::resetAssemblyState(), and eq::Channel::setupAssemblyState().

Here is the call graph for this function:

void eqPly::Channel::frameReadback ( const uint32_t frameID ) [protected, virtual]

Read back the rendered scene.

Called 0 to n times during one frame.

Parameters:

frameID

the per-frame identifier.

See also:: getOutputFrames

Reimplemented from eq::Channel.

Definition at line 218 of file examples/eqPly/channel.cpp.

References eq::Channel::getOutputFrames().

Here is the call graph for this function:

void eqPly::Channel::frameStart	(	const uint32_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()

Reimplemented from eq::Channel.

Definition at line 234 of file examples/eqPly/channel.cpp.

void eqPly::Channel::frameFinish	(	const uint32_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.

Reimplemented from eq::Channel.

Definition at line 249 of file examples/eqPly/channel.cpp.

void eqPly::Channel::frameViewStart ( const uint32_t frameID ) [protected, virtual]

Start updating a destination channel.

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

Parameters:

frameID

the per-frame identifier.

Reimplemented from eq::Channel.

Definition at line 242 of file examples/eqPly/channel.cpp.

References eq::Channel::getPixelViewport().

Here is the call graph for this function:

void eqPly::Channel::frameViewFinish ( const uint32_t frameID ) [protected, virtual]

Finish updating a destination channel.

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

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.

Reimplemented from eq::Channel.

Definition at line 267 of file examples/eqPly/channel.cpp.

References eq::Channel::applyBuffer(), eq::Channel::applyViewport(), eq::Channel::drawStatistics(), EQ_MAX, eq::Channel::getConfig(), eq::Channel::getEye(), eq::net::Object::getID(), eq::Channel::getPixelViewport(), eq::Channel::getView(), eq::Channel::resetAssemblyState(), eq::Config::sendEvent(), and eq::Channel::setupAssemblyState().