Equalizer  1.7.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
eq::fabric::Frame Class Reference

A holder for a frame data and related parameters. More...

#include <frame.h>

+ Inheritance diagram for eq::fabric::Frame:
+ Collaboration diagram for eq::fabric::Frame:

Public Types

enum  Buffer {
  BUFFER_NONE = LB_BIT_NONE, BUFFER_UNDEFINED = LB_BIT1, BUFFER_COLOR = LB_BIT5, BUFFER_DEPTH = LB_BIT9,
  BUFFER_ALL = LB_BIT_ALL_32
}
 The buffer format defines which components of the frame are to be used during readback and assembly. More...
 
enum  Type { TYPE_MEMORY, TYPE_TEXTURE }
 The storage type for pixel data. More...
 

Public Member Functions

EQFABRIC_API Frame ()
 Construct a new frame. More...
 
virtual EQFABRIC_API ~Frame ()
 Destruct the frame. More...
 
EQFABRIC_API const std::vector
< uint128_t > & 
getInputNodes (const Eye eye) const
 
EQFABRIC_API const co::NodeIDs & getInputNetNodes (const Eye eye) const
 
Data Access
EQFABRIC_API void setName (const std::string &name)
 Set the name of the frame. More...
 
EQFABRIC_API const std::string & getName () const
 
EQFABRIC_API const Vector2igetOffset () const
 
EQFABRIC_API void setOffset (const Vector2i &offset)
 Set the position of the frame wrt the channel. More...
 
EQFABRIC_API void setZoom (const Zoom &zoom)
 Set the zoom for this frame holder. More...
 
EQFABRIC_API const ZoomgetZoom () const
 
EQFABRIC_API const
co::ObjectVersion & 
getDataVersion (const Eye) const
 

Protected Member Functions

virtual ChangeType getChangeType () const
 
virtual EQFABRIC_API void getInstanceData (co::DataOStream &os)
 
virtual EQFABRIC_API void applyInstanceData (co::DataIStream &is)
 
EQFABRIC_API void _setDataVersion (const unsigned i, const co::ObjectVersion &ov)
 
EQFABRIC_API std::vector
< uint128_t > & 
_getInputNodes (const unsigned i)
 
EQFABRIC_API co::NodeIDs & _getInputNetNodes (const unsigned i)
 

Detailed Description

A holder for a frame data and related parameters.

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

Member Enumeration Documentation

The buffer format defines which components of the frame are to be used during readback and assembly.

Version
1.0
Enumerator
BUFFER_UNDEFINED 

Inherit, only if no others are set.

BUFFER_COLOR 

Use color images.

BUFFER_DEPTH 

Use depth images.

Definition at line 40 of file fabric/frame.h.

The storage type for pixel data.

Version
1.0
Enumerator
TYPE_MEMORY 

use main memory to store pixel data

TYPE_TEXTURE 

use a GL texture to store pixel data

Definition at line 50 of file fabric/frame.h.

Constructor & Destructor Documentation

EQFABRIC_API eq::fabric::Frame::Frame ( )

Construct a new frame.

Version
1.0
virtual EQFABRIC_API eq::fabric::Frame::~Frame ( )
virtual

Destruct the frame.

Version
1.0

Reimplemented in eq::Frame.

Member Function Documentation

EQFABRIC_API const std::string& eq::fabric::Frame::getName ( ) const
Returns
the name of the frame.
Version
1.0
EQFABRIC_API const Vector2i& eq::fabric::Frame::getOffset ( ) const
Returns
the position of the frame wrt the channel.
Version
1.0
EQFABRIC_API const Zoom& eq::fabric::Frame::getZoom ( ) const
Returns
the zoom factor for readback or assemble.
Version
1.0
EQFABRIC_API void eq::fabric::Frame::setName ( const std::string &  name)

Set the name of the frame.

Version
1.3.3
EQFABRIC_API void eq::fabric::Frame::setOffset ( const Vector2i offset)

Set the position of the frame wrt the channel.

The offset is only applied for operations on this frame holder, i.e., it does not apply to other (input) frames using the same underlying frame data.

Version
1.0
EQFABRIC_API void eq::fabric::Frame::setZoom ( const Zoom zoom)

Set the zoom for this frame holder.

The zoom is only applied for operations on this frame holder, i.e., it does not apply to other (input) frames using the same underlying frame data.

Version
1.0

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