Equalizer  1.11.0
Parallel Rendering Framework
eq/types.h
1 
2 /* Copyright (c) 2007-2016, Stefan Eilemann <eile@equalizergraphics.com>
3  * Daniel Nachbaur <danielnachbaur@gmail.com>
4  * Cedric Stalder <cedric.stalder@gmail.com>
5  *
6  * This library is free software; you can redistribute it and/or modify it under
7  * the terms of the GNU Lesser General Public License version 2.1 as published
8  * by the Free Software Foundation.
9  *
10  * This library is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with this library; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 #ifndef EQ_TYPES_H
21 #define EQ_TYPES_H
22 
23 #include <eq/defines.h>
24 #include <eq/util/types.h>
25 #include <eq/fabric/commands.h>
26 #include <eq/fabric/focusMode.h>
27 #include <eq/fabric/types.h>
28 #include <lunchbox/atomic.h>
29 #include <lunchbox/compiler.h>
30 
31 #include <map>
32 #include <vector>
33 
34 namespace eq
35 {
36 class Canvas;
37 class Channel;
38 class Client;
39 class CommandQueue;
40 class ComputeContext;
41 class Config;
42 class EventICommand;
43 class Frame;
44 class FrameData;
45 class Image;
46 class Layout;
47 class MessagePump;
48 class Node;
49 class NodeFactory;
50 class NotifierInterface;
51 class Observer;
52 class Pipe;
53 class ResultImageListener;
54 class Segment;
55 class Server;
56 class SystemPipe;
57 class SystemWindow;
58 class View;
59 class Window;
60 class WindowSettings;
61 class WindowSystem;
62 struct ConfigEvent;
63 struct ImageOp;
64 struct PixelData;
65 
66 using namespace fabric::eventEnums;
67 
68 using fabric::ANAGLYPH;
69 using fabric::ASYNC;
70 using fabric::AUTO;
71 using fabric::DRAW_SYNC;
72 using fabric::FASTEST;
73 using fabric::FBO;
74 using fabric::HORIZONTAL;
75 using fabric::LOCAL_SYNC;
76 using fabric::NICEST;
77 using fabric::OFF;
78 using fabric::ON;
79 using fabric::PBUFFER;
80 using fabric::QUAD;
81 using fabric::RGBA16F;
82 using fabric::RGBA32F;
83 using fabric::UNDEFINED;
84 using fabric::VERTICAL;
85 using fabric::WINDOW;
86 
87 using fabric::ColorMask;
88 using fabric::DrawableConfig;
89 using fabric::Errors;
90 using fabric::Event;
91 using fabric::Frustum;
92 using fabric::Frustumf;
93 using fabric::GPUInfo;
94 using fabric::IAttribute;
95 using fabric::KeyEvent;
96 using fabric::Pixel;
97 using fabric::PixelViewport;
98 using fabric::Projection;
99 using fabric::PointerEvent;
100 using fabric::Range;
101 using fabric::RenderContext;
102 using fabric::ResizeEvent;
103 using fabric::Statistic;
104 using fabric::SubPixel;
105 using fabric::Tile;
106 using fabric::Viewport;
107 using fabric::Wall;
108 using fabric::Zoom;
109 
112 
115 
118 
121 
124 
127 
130 
133 
136 
139 // cppcheck-suppress unnecessaryForwardDeclaration
140  CanvasVisitor, NodeVisitor > ConfigVisitor;
141 
144 
145 //----- Vectors
147 typedef std::vector< Config* > Configs;
149 typedef std::vector< Server* > Servers;
151 typedef std::vector< Node* > Nodes;
153 typedef std::vector< Pipe* > Pipes;
155 typedef std::vector< Window* > Windows;
157 typedef std::vector< Channel* > Channels;
159 typedef std::vector< Frame* > Frames;
161 typedef std::vector< Image* > Images;
163 typedef std::vector< Observer* > Observers;
165 typedef std::vector< Canvas* > Canvases;
167 typedef std::vector< Layout* > Layouts;
169 typedef std::vector< Segment* > Segments;
171 typedef std::vector< View* > Views;
173 typedef std::vector< PixelViewport > PixelViewports;
175 typedef std::vector< ImageOp > ImageOps;
176 
178 typedef Configs::const_iterator ConfigsCIter;
180 typedef Servers::const_iterator ServersCIter;
182 typedef Nodes::const_iterator NodesCIter;
184 typedef Pipes::const_iterator PipesCIter;
186 typedef Windows::const_iterator WindowsCIter;
188 typedef Channels::const_iterator ChannelsCIter;
190 typedef Frames::iterator FramesIter;
192 typedef Frames::const_iterator FramesCIter;
194 typedef Images::const_iterator ImagesCIter;
196 typedef Observers::const_iterator ObserversCIter;
198 typedef Canvases::const_iterator CanvasesCIter;
200 typedef Layouts::const_iterator LayoutsCIter;
202 typedef Segments::const_iterator SegmentsCIter;
204 typedef Views::const_iterator ViewsCIter;
206 typedef PixelViewports::const_iterator PixelViewportsCIter;
207 
209 typedef lunchbox::RefPtr< Client > ClientPtr;
211 typedef lunchbox::RefPtr< const Client > ConstClientPtr;
213 typedef lunchbox::RefPtr< Server > ServerPtr;
215 typedef lunchbox::RefPtr< FrameData > FrameDataPtr;
217 typedef lunchbox::RefPtr< const FrameData > ConstFrameDataPtr;
218 
219 using fabric::Matrix3d;
220 using fabric::Matrix4d;
221 using fabric::Matrix3f;
222 using fabric::Matrix4f;
223 using fabric::Vector2i;
224 using fabric::Vector3i;
225 using fabric::Vector4i;
226 using fabric::Vector3d;
227 using fabric::Vector4d;
228 using fabric::Vector2f;
229 using fabric::Vector3f;
230 using fabric::Vector4f;
231 using fabric::Vector3ub;
232 using fabric::Frustumf;
233 
234 using fabric::EventOCommand;
235 using fabric::FocusMode;
239 using fabric::CMD_CONFIG_EVENT;
240 
241 using fabric::Statistics;
242 using fabric::Strings;
243 using fabric::StringsCIter;
244 using fabric::Viewports;
245 
247 using vmml::FrustumCullerf;
248 
250 typedef std::vector< uint8_t > Vectorub;
252 typedef std::vector< uint16_t > Vectorus;
253 
254 using co::f_bool_t;
255 
256 using lunchbox::a_int32_t;
257 using lunchbox::backtrace;
258 using lunchbox::uint128_t;
259 
262 typedef co::WorkerThread< CommandQueue > Worker; // instantiated in worker.cpp
263 
264 namespace detail
265 {
266 class InitVisitor;
267 class ExitVisitor;
268 class FrameVisitor;
269 }
270 
271 namespace deflect { class Proxy; }
273 }
274 
276 // GLEW
277 struct GLEWContextStruct;
278 struct WGLEWContextStruct;
279 struct GLXEWContextStruct;
280 typedef struct GLEWContextStruct GLEWContext;
281 typedef struct WGLEWContextStruct WGLEWContext;
282 typedef struct GLXEWContextStruct GLXEWContext;
283 namespace GLStats { class Data; }
284 class QThread;
287 #endif // EQ_TYPES_H
fabric::ElementVisitor< Window, ChannelVisitor > WindowVisitor
A visitor to traverse windows and children.
Definition: eq/types.h:126
std::vector< Node * > Nodes
A vector of pointers to eq::Node.
Definition: eq/types.h:151
Channels::const_iterator ChannelsCIter
A const_iterator over a eq::Channel vector.
Definition: eq/types.h:188
std::vector< Server * > Servers
A vector of pointers to eq::Server.
Definition: eq/types.h:149
IAttribute
Possible values for integer attributes.
Definition: iAttribute.h:30
std::vector< ImageOp > ImageOps
A vector of image compositing operations.
Definition: eq/types.h:175
A visitor to traverse configs and all children.
Definition: configVisitor.h:36
Windows::const_iterator WindowsCIter
A const_iterator over a eq::Window vector.
Definition: eq/types.h:186
Segments::const_iterator SegmentsCIter
A const_iterator over a eq::Segment vector.
Definition: eq/types.h:202
A configuration is a visualization session driven by an application.
Definition: config.h:55
Images::const_iterator ImagesCIter
A const_iterator over a eq::Image vector.
Definition: eq/types.h:194
std::vector< Error > Errors
A vector of eq::fabric::Error.
Pipes::const_iterator PipesCIter
A const_iterator over a eq::Pipe vector.
Definition: eq/types.h:184
Canvases::const_iterator CanvasesCIter
A const_iterator over a eq::Canvas vector.
Definition: eq/types.h:198
Float32 framebuffer (WindowSettings::IATTR_PLANES_COLOR)
Definition: iAttribute.h:39
PBuffer drawable (WindowSettings::IATTR_HINT_DRAWABLE)
Definition: iAttribute.h:45
FBO drawable (WindowSettings::IATTR_HINT_DRAWABLE)
Definition: iAttribute.h:41
A visitor to traverse leaf nodes of a graph.
Definition: leafVisitor.h:28
std::vector< PixelViewport > PixelViewports
A vector of eq::PixelViewport.
Definition: eq/types.h:173
Focus distance relative and in -Z axis of origin.
Definition: focusMode.h:33
enabled (various attributes)
Definition: iAttribute.h:58
disabled (various attributes)
Definition: iAttribute.h:57
fabric::LeafVisitor< View > ViewVisitor
A visitor to traverse views.
Definition: eq/types.h:114
Vertical load-balancing.
Definition: iAttribute.h:47
Focus distance relative and in direction of observer.
Definition: focusMode.h:35
std::vector< Pipe * > Pipes
A vector of pointers to eq::Pipe.
Definition: eq/types.h:153
std::vector< Layout * > Layouts
A vector of pointers to eq::Layout.
Definition: eq/types.h:167
fabric::ElementVisitor< Pipe, WindowVisitor > PipeVisitor
A visitor to traverse pipes and children.
Definition: eq/types.h:129
lunchbox::RefPtr< Server > ServerPtr
A reference-counted pointer to an eq::Server.
Definition: eq/types.h:213
std::vector< Image * > Images
A vector of pointers to eq::Image.
Definition: eq/types.h:161
No local sync (Node::IATTR_THREAD_MODEL)
Definition: iAttribute.h:44
Nicest statistics gathering (WindowSettings::IATTR_HINT_STATISTICS, Channel::IATTR_HINT_STATISTICS) ...
Definition: iAttribute.h:55
A visitor to traverse non-leaf elements and their children in a tree.
Window drawable (WindowSettings::IATTR_HINT_DRAWABLE)
Definition: iAttribute.h:46
fabric::ElementVisitor< Server, ConfigVisitor > ServerVisitor
A visitor to traverse servers and children.
Definition: eq/types.h:143
Layouts::const_iterator LayoutsCIter
A const_iterator over a eq::Layout vector.
Definition: eq/types.h:200
std::vector< Window * > Windows
A vector of pointers to eq::Window.
Definition: eq/types.h:155
std::vector< View * > Views
A vector of pointers to eq::View.
Definition: eq/types.h:171
Automatic selection (various attributes)
Definition: iAttribute.h:56
Horizontal load-balancing.
Definition: iAttribute.h:64
Servers::const_iterator ServersCIter
A const_iterator over a eq::Server vector.
Definition: eq/types.h:180
fabric::ElementVisitor< Layout, ViewVisitor > LayoutVisitor
A visitor to traverse layouts and children.
Definition: eq/types.h:135
fabric::ElementVisitor< Node, PipeVisitor > NodeVisitor
A visitor to traverse nodes and children.
Definition: eq/types.h:132
Focus on physical projection.
Definition: focusMode.h:31
std::vector< uint8_t > Vectorub
A vector of bytes.
Definition: eq/types.h:250
FocusMode
The algorithm to use for observer focal distance calculation.
Definition: focusMode.h:29
std::vector< Observer * > Observers
A vector of pointers to eq::Observer.
Definition: eq/types.h:163
std::vector< Canvas * > Canvases
A vector of pointers to eq::Canvas.
Definition: eq/types.h:165
lunchbox::RefPtr< Client > ClientPtr
A reference-counted pointer to an eq::Client.
Definition: eq/types.h:209
Local draw sync (Node::IATTR_THREAD_MODEL)
Definition: iAttribute.h:43
Configs::const_iterator ConfigsCIter
A const_iterator over a eq::Config vector.
Definition: eq/types.h:178
The Equalizer client library.
Definition: eq/agl/types.h:23
std::vector< Frame * > Frames
A vector of pointers to eq::Frame.
Definition: eq/types.h:159
std::vector< Channel * > Channels
A vector of pointers to eq::Channel.
Definition: eq/types.h:157
fabric::ElementVisitor< Canvas, SegmentVisitor > CanvasVisitor
A visitor to traverse canvases and children.
Definition: eq/types.h:123
Quad-buffered stereo decomposition.
Definition: iAttribute.h:48
PixelViewports::const_iterator PixelViewportsCIter
A const_iterator over a eq::PixelViewport vector.
Definition: eq/types.h:206
Nodes::const_iterator NodesCIter
A const_iterator over a eq::Node vector.
Definition: eq/types.h:182
Frames::const_iterator FramesCIter
A const_iterator over a eq::Frame vector.
Definition: eq/types.h:192
fabric::LeafVisitor< Observer > ObserverVisitor
A visitor to traverse channels.
Definition: eq/types.h:117
lunchbox::RefPtr< const FrameData > ConstFrameDataPtr
A reference-counted pointer to a const eq::FrameData.
Definition: eq/types.h:217
Views::const_iterator ViewsCIter
A const_iterator over a eq::View vector.
Definition: eq/types.h:204
Anaglyphic stereo decomposition.
Definition: iAttribute.h:49
std::vector< Segment * > Segments
A vector of pointers to eq::Segment.
Definition: eq/types.h:169
std::vector< Statistic > Statistics
A vector of eq::Statistic events.
fabric::LeafVisitor< Channel > ChannelVisitor
A visitor to traverse channels.
Definition: eq/types.h:120
lunchbox::RefPtr< FrameData > FrameDataPtr
A reference-counted pointer to an eq::FrameData.
Definition: eq/types.h:215
fabric::LeafVisitor< Segment > SegmentVisitor
A visitor to traverse segments.
Definition: eq/types.h:111
Undefined value.
Definition: iAttribute.h:32
std::vector< uint16_t > Vectorus
A vector of unsigned shorts.
Definition: eq/types.h:252
Float16 framebuffer (WindowSettings::IATTR_PLANES_COLOR)
Definition: iAttribute.h:40
Full local sync (Node::IATTR_THREAD_MODEL)
Definition: iAttribute.h:42
Observers::const_iterator ObserversCIter
A const_iterator over a eq::Observer vector.
Definition: eq/types.h:196
lunchbox::RefPtr< const Client > ConstClientPtr
A reference-counted pointer to a const eq::Client.
Definition: eq/types.h:211
std::vector< Config * > Configs
A vector of pointers to eq::Config.
Definition: eq/types.h:147
Frames::iterator FramesIter
An iterator over a eq::Frame vector.
Definition: eq/types.h:190
Fastest statistics gathering (WindowSettings::IATTR_HINT_STATISTICS, Channel::IATTR_HINT_STATISTICS) ...
Definition: iAttribute.h:63
fabric::ConfigVisitor< Config, ObserverVisitor, LayoutVisitor, CanvasVisitor, NodeVisitor > ConfigVisitor
A visitor to traverse configs and children.
Definition: eq/types.h:140
std::vector< Viewport > Viewports
A vector of eq::Viewport.