eqPly::Pipe Class Reference

The representation of one GPU. More...

#include <pipe.h>

Inheritance diagram for eqPly::Pipe:

[legend]

Collaboration diagram for eqPly::Pipe:

[legend]

List of all members.

Public Member Functions
	Pipe (eq::Node *parent)
	Constructs a new pipe.
const FrameData &	getFrameData () const
Protected Member Functions
virtual	~Pipe ()
	Destructs the pipe.
virtual eq::WindowSystem	selectWindowSystem () const
	Return the window system to be used by this pipe.
virtual bool	configInit (const uint32_t initID)
	Initialize this pipe.
virtual bool	configExit ()
	Exit this pipe.
virtual void	frameStart (const uint32_t frameID, const uint32_t frameNumber)
	Start rendering a frame.

---

Detailed Description

The representation of one GPU.

The pipe object is responsible for maintaining GPU-specific and frame-specific data. The identifier passed by the configuration contains the version of the frame data corresponding to the rendered frame. The pipe's start frame callback synchronizes the thread-local instance of the frame data to this version.

Definition at line 36 of file examples/eqPly/pipe.h.

---

Constructor & Destructor Documentation

eqPly::Pipe::Pipe

(

eq::Node *

parent

)

[inline]

Constructs a new pipe.

Reimplemented from eq::Pipe.

Definition at line 39 of file examples/eqPly/pipe.h.

virtual eqPly::Pipe::~Pipe

(

)

[inline, protected, virtual]

Destructs the pipe.

Reimplemented from eq::Pipe.

Definition at line 44 of file examples/eqPly/pipe.h.

---

Member Function Documentation

eq::WindowSystem eqPly::Pipe::selectWindowSystem

(

)

const [protected, virtual]

Return the window system to be used by this pipe.

This function determines which of the supported windowing systems is used by this pipe instance.

Returns:

the window system currently used by this pipe.

Reimplemented from eq::Pipe.

Definition at line 30 of file examples/eqPly/pipe.cpp.

References EQWARN, and eq::Pipe::supportsWindowSystem().

Here is the call graph for this function:

bool eqPly::Pipe::configInit

(

const uint32_t

initID

)

[protected, virtual]

Initialize this pipe.

Parameters:

initID

the init identifier.

Reimplemented from eq::Pipe.

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

References eq::Pipe::configInit(), and eq::net::Session::mapObject().

Here is the call graph for this function:

void eqPly::Pipe::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 pipe-specific data, for example updating the rendering engine. Waits for the node to start the frame, unless the thread model is async. If the thread model is async, the local synchronization is released immediately.

This method has to call startFrame().

Parameters:

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

See also:

Config::beginFrame(), Node::startFrame(), Node::waitFrameStarted()

Reimplemented from eq::Pipe.

Definition at line 70 of file examples/eqPly/pipe.cpp.

References eq::net::Object::sync().

Here is the call graph for this function:

---

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

• examples/eqPly/pipe.h
• examples/eqPly/pipe.cpp