Equalizer  1.13.0
Parallel Rendering Framework
eq Namespace Reference

The Equalizer client library. More...

Namespaces

 agl
 The system abstraction layer for Apple OpenGL and Carbon.
 
 fabric
 The Equalizer data synchronization fabric.
 
 glx
 The system abstraction layer for X11 and glX.
 
 qt
 The system abstraction layer for Qt.
 
 util
 Equalizer utility classes.
 
 wgl
 The system abstraction layer for Windows OpenGL.
 
 x11
 An abstraction layer for CPU-based rendering using X11.
 

Classes

class  Canvas
 A canvas represents a logical 2D projection surface. More...
 
class  Channel
 A channel represents a two-dimensional viewport within a Window. More...
 
class  ChannelStatistics
 Samples one channel statistics event. More...
 
class  Client
 The client represents a network node of the application in the cluster. More...
 
class  CommandQueue
 
class  Compositor
 A set of functions performing compositing for a set of input frames. More...
 
class  Config
 A configuration is a visualization session driven by an application. More...
 
struct  ConfigEvent
 
class  ConfigStatistics
 Samples one Config statistics event. More...
 
class  EventHandler
 Base class for window system-specific event handlers. More...
 
class  EventICommand
 A command specialization for config events. More...
 
class  Exception
 Exception class for Equalizer operations. More...
 
class  Frame
 A holder for a frame data and related parameters. More...
 
class  FrameData
 A holder for multiple images. More...
 
class  GLException
 OpenGL Exception. More...
 
class  Global
 Global parameter handling for the Equalizer client library. More...
 
class  GLWindow
 A system window for OpenGL rendering. More...
 
class  Image
 A holder for pixel data. More...
 
struct  ImageOp
 A structure describing an image assembly task, used by the Compositor. More...
 
class  Layout
 A layout groups one or more View, logically belonging together. More...
 
class  MessagePump
 An interface to process system messages or events. More...
 
class  Node
 A Node represents a single computer in the cluster. More...
 
class  NodeFactory
 The node factory is a per-node singleton used to create and release Equalizer resource instances. More...
 
class  NotifierInterface
 A base class for notifying errors and events. More...
 
class  Observer
 An Observer looks at one or more views from a certain position (head matrix) with a given eye separation. More...
 
class  Pipe
 A Pipe represents a graphics card (GPU) on a Node. More...
 
struct  PixelData
 The pixel data structure manages the pixel information for images. More...
 
class  ResultImageListener
 The result image listener gets notified on new images produced by destination channels. More...
 
class  Segment
 A segment covers a sub-area of a Canvas. More...
 
class  Server
 Proxy object for the connection to an Equalizer server. More...
 
class  StatisticSampler
 Utility to sample an statistics event. More...
 
class  SystemPipe
 The interface definition for system-specific GPU handling. More...
 
class  SystemWindow
 The interface definition for system-specific windowing code. More...
 
class  Version
 Information about the current Equalizer version. More...
 
class  View
 A View is a 2D area of a Layout. More...
 
class  Window
 A Window represents an on-screen or off-screen drawable. More...
 
class  WindowSettings
 A set of settings to setup an eq::SystemWindow. More...
 
class  WindowStatistics
 A statistics sampler for window-related events. More...
 
class  WindowSystem
 
class  WindowSystemIF
 The interface for windowing toolkits. More...
 

Typedefs

typedef fabric::LeafVisitor< SegmentSegmentVisitor
 A visitor to traverse segments. More...
 
typedef fabric::LeafVisitor< ViewViewVisitor
 A visitor to traverse views. More...
 
typedef fabric::LeafVisitor< ObserverObserverVisitor
 A visitor to traverse channels. More...
 
typedef fabric::LeafVisitor< ChannelChannelVisitor
 A visitor to traverse channels. More...
 
typedef fabric::ElementVisitor< Canvas, SegmentVisitorCanvasVisitor
 A visitor to traverse canvases and children. More...
 
typedef fabric::ElementVisitor< Window, ChannelVisitorWindowVisitor
 A visitor to traverse windows and children. More...
 
typedef fabric::ElementVisitor< Pipe, WindowVisitorPipeVisitor
 A visitor to traverse pipes and children. More...
 
typedef fabric::ElementVisitor< Node, PipeVisitorNodeVisitor
 A visitor to traverse nodes and children. More...
 
typedef fabric::ElementVisitor< Layout, ViewVisitorLayoutVisitor
 A visitor to traverse layouts and children. More...
 
typedef fabric::ConfigVisitor< Config, ObserverVisitor, LayoutVisitor, CanvasVisitor, NodeVisitorConfigVisitor
 A visitor to traverse configs and children. More...
 
typedef fabric::ElementVisitor< Server, ConfigVisitorServerVisitor
 A visitor to traverse servers and children. More...
 
typedef std::vector< Config * > Configs
 A vector of pointers to eq::Config.
 
typedef std::vector< Server * > Servers
 A vector of pointers to eq::Server.
 
typedef std::vector< Node * > Nodes
 A vector of pointers to eq::Node.
 
typedef std::vector< Pipe * > Pipes
 A vector of pointers to eq::Pipe.
 
typedef std::vector< Window * > Windows
 A vector of pointers to eq::Window.
 
typedef std::vector< Channel * > Channels
 A vector of pointers to eq::Channel.
 
typedef std::vector< Frame * > Frames
 A vector of pointers to eq::Frame.
 
typedef std::vector< Image * > Images
 A vector of pointers to eq::Image.
 
typedef std::vector< Observer * > Observers
 A vector of pointers to eq::Observer.
 
typedef std::vector< Canvas * > Canvases
 A vector of pointers to eq::Canvas.
 
typedef std::vector< Layout * > Layouts
 A vector of pointers to eq::Layout.
 
typedef std::vector< Segment * > Segments
 A vector of pointers to eq::Segment.
 
typedef std::vector< View * > Views
 A vector of pointers to eq::View.
 
typedef std::vector< PixelViewport > PixelViewports
 A vector of eq::PixelViewport.
 
typedef std::vector< ImageOpImageOps
 A vector of image compositing operations. More...
 
typedef Configs::const_iterator ConfigsCIter
 A const_iterator over a eq::Config vector.
 
typedef Servers::const_iterator ServersCIter
 A const_iterator over a eq::Server vector.
 
typedef Nodes::const_iterator NodesCIter
 A const_iterator over a eq::Node vector.
 
typedef Pipes::const_iterator PipesCIter
 A const_iterator over a eq::Pipe vector.
 
typedef Windows::const_iterator WindowsCIter
 A const_iterator over a eq::Window vector.
 
typedef Channels::const_iterator ChannelsCIter
 A const_iterator over a eq::Channel vector.
 
typedef Frames::iterator FramesIter
 An iterator over a eq::Frame vector.
 
typedef Frames::const_iterator FramesCIter
 A const_iterator over a eq::Frame vector.
 
typedef Images::const_iterator ImagesCIter
 A const_iterator over a eq::Image vector.
 
typedef Observers::const_iterator ObserversCIter
 A const_iterator over a eq::Observer vector.
 
typedef Canvases::const_iterator CanvasesCIter
 A const_iterator over a eq::Canvas vector.
 
typedef Layouts::const_iterator LayoutsCIter
 A const_iterator over a eq::Layout vector.
 
typedef Segments::const_iterator SegmentsCIter
 A const_iterator over a eq::Segment vector.
 
typedef Views::const_iterator ViewsCIter
 A const_iterator over a eq::View vector.
 
typedef PixelViewports::const_iterator PixelViewportsCIter
 A const_iterator over a eq::PixelViewport vector.
 
typedef lunchbox::RefPtr< ClientClientPtr
 A reference-counted pointer to an eq::Client.
 
typedef lunchbox::RefPtr< const ClientConstClientPtr
 A reference-counted pointer to a const eq::Client.
 
typedef lunchbox::RefPtr< ServerServerPtr
 A reference-counted pointer to an eq::Server.
 
typedef lunchbox::RefPtr< FrameDataFrameDataPtr
 A reference-counted pointer to an eq::FrameData.
 
typedef lunchbox::RefPtr< const FrameDataConstFrameDataPtr
 A reference-counted pointer to a const eq::FrameData.
 
typedef std::vector< uint8_t > Vectorub
 A vector of bytes.
 
typedef std::vector< uint16_t > Vectorus
 A vector of unsigned shorts.
 

Enumerations

enum  LogTopics {
  LOG_BUG = lunchbox::LOG_BUG, LOG_PLUGIN = pression::LOG_PLUGIN, LOG_INIT = fabric::LOG_INIT, LOG_ASSEMBLY = fabric::LOG_ASSEMBLY,
  LOG_TASKS = fabric::LOG_TASKS, LOG_STATS = fabric::LOG_CUSTOM << 0, LOG_CUSTOM = 0x10000
}
 Defines selective logging classes enabled by setting LB_LOG_TOPICS. More...
 
enum  ZoomFilter { FILTER_NEAREST = 0x2600, FILTER_LINEAR = 0x2601 }
 Filtering algorithm to applied during zoom operations. More...
 

Functions

EQ_API std::ostream & operator<< (std::ostream &os, const ConfigEvent *event)
 Print the config event to the given output stream. More...
 
EQ_API std::ostream & operator<< (std::ostream &os, const EventICommand &command)
 Print the event command to the given output stream. More...
 
EQ_API std::ostream & operator<< (std::ostream &, const FrameData &)
 Print the frame data to the given output stream. More...
 
EQ_API void debugGLError (const std::string &when, const GLenum error, const char *file, const int line)
 Output an error OpenGL in a human-readable form to LBWARN.
 
EQ_API std::string glError (const GLenum error)
 
EQ_API bool _init (const int argc, char **argv, NodeFactory *nodeFactory)
 
bool init (const int argc, char **argv, NodeFactory *nodeFactory)
 Initialize the Equalizer client library. More...
 
EQ_API bool exit ()
 De-initialize the Equalizer client library. More...
 
EQ_API ConfiggetConfig (const int argc, char **argv)
 Convenience function to retrieve a configuration. More...
 
EQ_API void releaseConfig (Config *config)
 Convenience function to release a configuration. More...
 
EQ_API std::ostream & operator<< (std::ostream &os, const WindowSystem &)
 Print the window system name to the given output stream. More...
 
EQ_API co::DataOStream & operator<< (co::DataOStream &os, const WindowSystem &)
 co::Object serializer. More...
 
EQ_API co::DataIStream & operator>> (co::DataIStream &is, WindowSystem &ws)
 WindowSystem deserializer. More...
 

Detailed Description

The Equalizer client library.

This namespace implements the application-visible API to access the Equalizer server.

The Client represents the application instance and co::Node. A Client can connect to a Server to retrieve a Config.

The Server, Config, Node, Window and Channel hierarchy represents the rendering entities as described in the configuration file. Each process in the cluster only has the local entities instantiated, that is, there is at most one node per process. The Config is a co::Session, which is normally used to register distributed objects based on eq::Object or co::Object.

The Canvas, Segment, Layout, View and Observer hierarchy represents the physical projection system, logical layout and tracked users. Applications which want to be multi-view capable typically extend the View to attach application-specific data, e.g., a camera position or model.

A ConfigVisitor, NodeVisitor, PipeVisitor, WindowVisitor, ChannelVisitor, CanvasVisitor, SegmentVisitor, LayoutVisitor, ViewVisitor or ObserverVisitor may be used to traverse the corresponding entity and to execute methods for each child of the hierarchy.

The SystemWindow is used by the Window and abstracts window-system specific functionality. The GLWindow implements generic OpenGL functionality, and is in turn sub-classed by the interfaces GLXWindowIF, AGLWindowIF and WGLWindowIF, which extend the GLWindow by GLX, AGL and WGL-specific functionality. The GLXWindow, AGLWindow and WGLWindow implement the aforementioned interfaces.

The SystemPipe, GLXPipe, AGLPipe and WGLPipe hierarchy implements a similar abstraction for GPU-specific functionality.

The GLXMessagePump, AGLMessagePump and WGLMessagePump are used by the node and pipe threads to detect and dispatch system events. The GLXEventHandler, AGLEventHandler and WGLEventHandler receive these events and transform them into a AGLWindowEvent, GLXWindowEvent or WGLWindowEvent, respectively.

The window events are dispatched to the corresponding SystemWindow, which can execute window system specific tasks. The SystemWindow implementations forward the generic Event to the window. The window will handle the necessary events locally, and will transform the WindowEvent into a ConfigEvent, which is sent to the application node using Config::sendEvent().

The Event is a union of the possible concrete PointerEvent, KeyEvent, ResizeEvent, MagellanEvent, Statistic or UserEvent and may contain a valid RenderContext for a PointerEvent. The RenderContext describes the rendering setup of the last Channel draw operation on the pointer position.

During scalable rendering, a Frame is used to represent an output frame during Channel::frameReadback or an input frame during Channel::frameAssemble. Each Frame holds a FrameData, which is a container for images and links the input with the output frames. An Image represents a 2D framebuffer area, containing color and/or depth information.

Typedef Documentation

A visitor to traverse canvases and children.

Definition at line 122 of file eq/types.h.

A visitor to traverse channels.

See also
Channel::accept()

Definition at line 119 of file eq/types.h.

A visitor to traverse configs and children.

Definition at line 139 of file eq/types.h.

typedef std::vector< ImageOp > eq::ImageOps

A vector of image compositing operations.

Definition at line 174 of file eq/types.h.

A visitor to traverse layouts and children.

Definition at line 134 of file eq/types.h.

A visitor to traverse nodes and children.

Definition at line 131 of file eq/types.h.

A visitor to traverse channels.

See also
Channel::accept()

Definition at line 116 of file eq/types.h.

A visitor to traverse pipes and children.

Definition at line 128 of file eq/types.h.

A visitor to traverse segments.

See also
Segment::accept()

Definition at line 110 of file eq/types.h.

A visitor to traverse servers and children.

Definition at line 142 of file eq/types.h.

A visitor to traverse views.

See also
View::accept()

Definition at line 113 of file eq/types.h.

A visitor to traverse windows and children.

Definition at line 125 of file eq/types.h.

Enumeration Type Documentation

Defines selective logging classes enabled by setting LB_LOG_TOPICS.

Enumerator
LOG_BUG 

Potential bugs (4)

LOG_PLUGIN 

Plugin usage (16)

LOG_INIT 

Initialization (512)

LOG_ASSEMBLY 

Compositing tasks (1024)

LOG_TASKS 

Rendering tasks (2048)

LOG_STATS 

Statistic events (32768)

LOG_CUSTOM 

User-defined log topics (65536)

Definition at line 27 of file log.h.

Filtering algorithm to applied during zoom operations.

Enumerator
FILTER_NEAREST 

GL_NEAREST.

FILTER_LINEAR 

GL_LINEAR.

Definition at line 25 of file zoomFilter.h.

Function Documentation

EQ_API bool eq::exit ( )

De-initialize the Equalizer client library.

De-initialize the Equalizer fabric namespace.

Returns
true if the library was successfully de-initialized, false otherwise.
EQ_API Config* eq::getConfig ( const int  argc,
char **  argv 
)

Convenience function to retrieve a configuration.

This function initializes a local client node, connects it to the server, and retrieves a configuration. On any failure everything is correctly deinitialized and 0 is returned.

Returns
the pointer to a configuration, or 0 upon error.
EQ_API std::string eq::glError ( const GLenum  error)
Returns
the given error in human-readable form.
bool eq::init ( const int  argc,
char **  argv,
NodeFactory nodeFactory 
)
inline

Initialize the Equalizer client library.

The following command line options are recognized by this function:

  • –eq-logfile <filename> redirect all log output to the given file.
  • –eq-server <hostname> to specify an explicit server address (cf. Global::setServer())
  • –eq-config <filename> to specify the configuration file or hwsd session if an application-specific server is used (cf. Global::setConfigFile())
  • –eq-render-client <filename> to specify an alternate name for the render client executable (default is argv[0]). Also sets the working directory to the director part of the filename.

Please note that further command line parameters are recognized by co::LocalNode::initLocal().

exit() should be called independent of the return value of this function.

Parameters
argcthe command line argument count.
argvthe command line argument values.
nodeFactorythe factory for allocating Equalizer objects.
Returns
true if the library was successfully initialized, false otherwise.

Definition at line 58 of file init.h.

References EQ_VERSION_ABI, and eq::Version::getABI().

+ Here is the call graph for this function:

EQ_API std::ostream& eq::operator<< ( std::ostream &  os,
const ConfigEvent event 
)

Print the config event to the given output stream.

Version
1.0
EQ_API std::ostream& eq::operator<< ( std::ostream &  os,
const EventICommand command 
)

Print the event command to the given output stream.

Version
1.5.1
EQ_API std::ostream& eq::operator<< ( std::ostream &  os,
const WindowSystem  
)

Print the window system name to the given output stream.

Version
1.0
EQ_API co::DataOStream& eq::operator<< ( co::DataOStream &  os,
const WindowSystem  
)

co::Object serializer.

Version
1.1.3
EQ_API std::ostream& eq::operator<< ( std::ostream &  ,
const FrameData  
)

Print the frame data to the given output stream.

Version
1.4
EQ_API co::DataIStream& eq::operator>> ( co::DataIStream &  is,
WindowSystem ws 
)

WindowSystem deserializer.

Version
1.1.3
EQ_API void eq::releaseConfig ( Config config)

Convenience function to release a configuration.

This function releases the configuration, disconnects the server, and stops the local client node.