eq::fabric Namespace Reference

The Equalizer data synchronization fabric. More...

Classes
class	Canvas
	A canvas represents a logical 2D projection surface. More...
class	Channel
	Base data transport class for channels. More...
class	Client
	A client represents a network node of the application in the cluster. More...
class	ColorMask
	Defines which parts of the color buffer are to be written. More...
class	Config
	Base data class for a configuration. More...
class	ConfigVisitor
	A visitor to traverse configs and all children. More...
struct	DrawableConfig
	Stores the characteristics of a window's frame buffer configuration. More...
class	ElementVisitor
	A visitor to traverse non-leaf elements and their children in a tree. More...
class	Frustum
	A distributed object for frustum data. More...
class	Global
	Global parameter handling for the Equalizer fabric namespace. More...
class	Layout
	Base data transport class for layouts. More...
class	LeafVisitor
	A visitor to traverse leaf nodes of a graph. More...
class	Node
	Base data transport class for nodes. More...
class	Object
	Internal base class for all distributed, inheritable Equalizer objects. More...
class	Observer
	Base data transport class for observers. More...
class	Pipe
	Base data transport class for pipes. More...
class	Pixel
	Holds a pixel decomposition specification with methods for manipulation. More...
class	PixelViewport
	Holds a 2D pixel viewport with methods for manipulation. More...
class	Projection
	A projector definition defining a view frustum. More...
class	Range
	A fractional database range with methods for manipulation. More...
class	RenderContext
	The context applied to a channel during rendering operations. More...
class	Segment
	Base data transport class for segments. More...
class	Serializable
	Base class for all distributed, inheritable objects. More...
class	Server
	Base co::Node class for a server. More...
class	SubPixel
	Holds a subpixel decomposition specification along with some methods for manipulation. More...
class	View
	Base data transport class for views. More...
class	Viewport
	A fractional viewport with methods for manipulation. More...
class	Wall
	A wall defining a view frustum. More...
class	Window
	Base data transport class for windows. More...
class	Zoom
	A zoom specification with methods for manipulation. More...
Functions
template<class CFG , class C , class S , class L >
std::ostream &	operator<< (std::ostream &, const Canvas< CFG, C, S, L > &)
template<class W , class C >
EQFABRIC_INL std::ostream &	operator<< (std::ostream &, const Channel< W, C > &)
std::ostream &	operator<< (std::ostream &os, const ColorMask &mask)
template<class S , class C , class O , class L , class CV , class N , class V >
EQFABRIC_INL std::ostream &	operator<< (std::ostream &os, const Config< S, C, O, L, CV, N, V > &config)
std::ostream &	operator<< (std::ostream &os, const DrawableConfig &config)
std::ostream &	operator<< (std::ostream &os, const Error &error)
	Print the error in a human-readable format.
std::ostream &	operator<< (std::ostream &os, const Eye &eye)
std::ostream &	operator<< (std::ostream &os, const Frustum &)
co::DataOStream &	operator<< (co::DataOStream &, const Frustum &)
co::DataIStream &	operator>> (co::DataIStream &, Frustum &)
std::ostream &	operator<< (std::ostream &os, const IAttribute value)
bool	init (const int argc, char **argv)
	Initialize the Equalizer fabric namespace.
bool	exit ()
	De-initialize the Equalizer fabric namespace.
template<class C , class L , class V >
std::ostream &	operator<< (std::ostream &, const Layout< C, L, V > &)
template<class C , class N , class P , class V >
EQFABRIC_INL std::ostream &	operator<< (std::ostream &, const Node< C, N, P, V > &)
template<class C , class O >
EQFABRIC_INL std::ostream &	operator<< (std::ostream &, const Observer< C, O > &)
template<class N , class P , class W , class V >
EQFABRIC_INL std::ostream &	operator<< (std::ostream &, const Pipe< N, P, W, V > &)
std::ostream &	operator<< (std::ostream &os, const Pixel &pixel)
std::ostream &	operator<< (std::ostream &os, const PixelViewport &pvp)
std::ostream &	operator<< (std::ostream &os, const Projection &)
std::ostream &	operator<< (std::ostream &os, const Range &range)
std::ostream &	operator<< (std::ostream &os, const RenderContext &ctx)
template<class C , class S , class CH >
std::ostream &	operator<< (std::ostream &, const Segment< C, S, CH > &)
template<class CL , class S , class CFG , class NF , class N >
EQFABRIC_INL std::ostream &	operator<< (std::ostream &, const Server< CL, S, CFG, NF, N > &)
std::ostream &	operator<< (std::ostream &os, const SubPixel &subPixel)
template<class L , class V , class O >
EQFABRIC_INL std::ostream &	operator<< (std::ostream &os, const View< L, V, O > &view)
std::ostream &	operator<< (std::ostream &os, const Viewport &vp)
std::ostream &	operator<< (std::ostream &os, const VisitorResult &result)
std::ostream &	operator<< (std::ostream &, const Wall &)
std::ostream &	operator<< (std::ostream &, const Wall::Type &)
template<class P , class W , class C >
EQFABRIC_INL std::ostream &	operator<< (std::ostream &os, const Window< P, W, C > &window)
std::ostream &	operator<< (std::ostream &os, const Zoom &zoom)
Typedefs
typedef vmml::matrix < 3, 3, double >	Matrix3d
	A 3x3 double matrix.
typedef vmml::matrix < 4, 4, double >	Matrix4d
	A 4x4 double matrix.
typedef vmml::matrix< 3, 3, float >	Matrix3f
	A 3x3 float matrix.
typedef vmml::matrix< 4, 4, float >	Matrix4f
	A 4x4 float matrix.
typedef vmml::vector< 2, int >	Vector2i
	A two-component integer vector.
typedef vmml::vector< 3, int >	Vector3i
	A three-component integer vector.
typedef vmml::vector< 4, int >	Vector4i
	A four-component integer vector.
typedef vmml::vector< 3, double >	Vector3d
	A three-component double vector.
typedef vmml::vector< 4, double >	Vector4d
	A four-component double vector.
typedef vmml::vector< 2, float >	Vector2f
	A two-component float vector.
typedef vmml::vector< 3, float >	Vector3f
	A three-component float vector.
typedef vmml::vector< 4, float >	Vector4f
	A four-component float vector.
typedef vmml::vector < 3, unsigned char >	Vector3ub
	A three-component byte vector.
typedef vmml::frustum< float >	Frustumf
	A frustum definition.
typedef co::base::uint128_t	uint128_t
typedef co::base::RefPtr< Client >	ClientPtr
typedef co::base::RefPtr < const Client >	ConstClientPtr
Enumerations
enum	Error { ERROR_CUSTOM = EQ_64KB }
	Defines errors produced by Equalizer classes. More...
enum	Eye {   EYE_UNDEFINED = 0, EYE_CYCLOP = 1, EYE_LEFT = 2, EYE_RIGHT = 4,   EYES_STEREO = EYE_LEFT | EYE_RIGHT, EYE_LAST = EYE_RIGHT, EYES_ALL = 7, NUM_EYES = 3 }
	Eye pass bit mask for which is enabled. More...
enum	IAttribute {   UNDEFINED = -0xfffffff, RGBA32F = -14, RGBA16F = -13, FBO = -12,   LOCAL_SYNC = -11, DRAW_SYNC = -10, ASYNC = -9, PBUFFER = -8,   WINDOW = -7, VERTICAL = -6, QUAD = -5, ANAGLYPH = -4,   PASSIVE = -3, NICEST = -2, AUTO = -1, OFF = 0,   ON = 1, FASTEST = ON, HORIZONTAL = ON }
	Possible values for integer attributes. More...
enum	LogTopics { LOG_INIT = co::LOG_CUSTOM << 0, LOG_CUSTOM = 0x400 }
	Defines selective logging classes enabled by setting EQ_LOG_TOPICS. More...
enum	NodeType { NODETYPE_EQ_SERVER = co::NODETYPE_CO_USER }
	Node types to identify connecting nodes. More...
enum	PacketType { PACKETTYPE_EQ_CLIENT = co::PACKETTYPE_CO_CUSTOM, PACKETTYPE_EQ_SERVER, PACKETTYPE_EQ_CUSTOM = 1<<8 }
	Packet types to identify the target of a packet. More...
enum	Task {   TASK_NONE = EQ_BIT_NONE, TASK_DEFAULT = EQ_BIT1, TASK_VIEW = EQ_BIT2, TASK_CLEAR = EQ_BIT5,   TASK_CULL = EQ_BIT9, TASK_DRAW = EQ_BIT13, TASK_ASSEMBLE = EQ_BIT17, TASK_READBACK = EQ_BIT21,   TASK_ALL = EQ_BIT_ALL }
	Tasks define the actions executed by a channel during rendering. More...
enum	VisitorResult { TRAVERSE_CONTINUE, TRAVERSE_TERMINATE, TRAVERSE_PRUNE }
	The result code from any visit operation. More...

---

Detailed Description

The Equalizer data synchronization fabric.

This namespace implements the common data management and transport layer between the Equalizer applications, the server and the administrative interface, which use the eq, eq::server and eq::admin namespace, respectively.

---

Function Documentation

bool eq::fabric::exit

(

)

De-initialize the Equalizer fabric namespace.

De-initialize the Equalizer base classes.

Returns:

true if the library was successfully de-initialized, false otherwise.

Version:

1.0

bool eq::fabric::init	(	const int	argc,
		char **	argv
	)

Initialize the Equalizer fabric namespace.

Initialize the Equalizer base classes.

Parameters:

argc	the command line argument count.
argv	the command line argument values.

Returns:

true if the library was successfully initialized, false otherwise.

Version:

1.0

std::ostream& eq::fabric::operator<<	(	std::ostream &	os,
		const Error &	error
	)		[inline]

Print the error in a human-readable format.

Version:

1.0

Definition at line 36 of file include/eq/fabric/error.h.

---

Enumeration Type Documentation

enum eq::fabric::Error

Defines errors produced by Equalizer classes.

Definition at line 29 of file include/eq/fabric/error.h.

enum eq::fabric::Eye

Eye pass bit mask for which is enabled.

Enumerator:

EYE_CYCLOP	monoscopic 'middle' eye
EYE_LEFT	left eye
EYE_RIGHT	right eye
EYES_STEREO	left and right eye
EYE_LAST	the last Eye
EYES_ALL	all eye

Definition at line 32 of file fabric/eye.h.

enum eq::fabric::IAttribute

Possible values for integer attributes.

Enumerator:

UNDEFINED	Undefined value.
RGBA32F	Float32 framebuffer (Window::IATTR_PLANES_COLOR)
RGBA16F	Float16 framebuffer (Window::IATTR_PLANES_COLOR)
FBO	FBO drawable (Window::IATTR_HINT_DRAWABLE)
LOCAL_SYNC	Full local sync (Node::IATTR_THREAD_MODEL)
DRAW_SYNC	Local draw sync (Node::IATTR_THREAD_MODEL)
ASYNC	No local sync (Node::IATTR_THREAD_MODEL)
PBUFFER	PBuffer drawable (Window::IATTR_HINT_DRAWABLE)
WINDOW	Window drawable (Window::IATTR_HINT_DRAWABLE)
VERTICAL	Vertical load-balancing.
QUAD	Quad-buffered stereo decomposition.
ANAGLYPH	Anaglyphic stereo decomposition.
PASSIVE	Passive stereo rendering.
NICEST	Nicest statisics gathering (Window::IATTR_HINT_STATISTICS, Channel::IATTR_HINT_STATISTICS)
AUTO	Automatic selection (various attributes)
OFF	disabled (various attributes)
ON	enabled (various attributes)
FASTEST	Fastest statisics gathering (Window::IATTR_HINT_STATISTICS, Channel::IATTR_HINT_STATISTICS)
HORIZONTAL	Horizontal load-balancing.

Definition at line 29 of file iAttribute.h.

enum eq::fabric::LogTopics

Defines selective logging classes enabled by setting EQ_LOG_TOPICS.

Enumerator:

LOG_INIT	Log initialization (256)
LOG_CUSTOM	1024

Definition at line 28 of file eq/fabric/log.h.

enum eq::fabric::NodeType

Node types to identify connecting nodes.

Enumerator:

NODETYPE_EQ_SERVER

A server node.

Definition at line 28 of file eq/fabric/nodeType.h.

enum eq::fabric::PacketType

Packet types to identify the target of a packet.

Definition at line 28 of file packetType.h.

enum eq::fabric::Task

Tasks define the actions executed by a channel during rendering.

The enum values are spaced apart to leave room for future additions without breaking binary backward compatibility.

Enumerator:

TASK_DEFAULT	leaf: all, other ASSEMBLE|READBACK|VIEW
TASK_VIEW	View start/finish.
TASK_CLEAR	Clear the framebuffer.
TASK_CULL	Cull data [unused].
TASK_DRAW	Draw data to the framebuffer.
TASK_ASSEMBLE	Combine input frames.
TASK_READBACK	Read results to output frames.

Definition at line 35 of file task.h.

enum eq::fabric::VisitorResult

The result code from any visit operation.

Enumerator:

TRAVERSE_CONTINUE	continue the traversal
TRAVERSE_TERMINATE	abort the traversal
TRAVERSE_PRUNE	do not traverse current entity downwards

Definition at line 28 of file fabric/visitorResult.h.