Equalizer  1.4.1
Public Member Functions
eq::Frame Class Reference

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

#include <frame.h>

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

List of all members.

Public Member Functions

 Frame ()
 Construct a new frame.
virtual ~Frame ()
 Destruct the frame.
Data Access
const std::string & getName () const
const Range & getRange () const
const Pixel & getPixel () const
const SubPixel & getSubPixel () const
uint32_t getPeriod () const
uint32_t getPhase () const
void setZoomFilter (const ZoomFilter zoomFilter)
 Set the filter applied to zoomed assemble operations.
ZoomFilter getZoomFilter () const
const ImagesgetImages () const
void setData (FrameData *data)
 Set the data for this frame.
FrameDatagetData ()
const FrameDatagetData () const
void setFrameData (FrameDataPtr data)
 Set the data for this frame.
FrameDataPtr getFrameData ()
ConstFrameDataPtr getFrameData () const
uint32_t getBuffers () const
void disableBuffer (const Buffer buffer)
 Disable the usage of a frame buffer attachment for all images.
void setAlphaUsage (const bool useAlpha)
 Set alpha usage for newly allocated images.
void setQuality (const Frame::Buffer buffer, const float quality)
 Set the minimum quality after compression.
void useCompressor (const Frame::Buffer buffer, const uint32_t name)
 Sets a compressor for compression for following transmissions.
Operations
void clear ()
void deleteGLObjects (ObjectManager *om)
void readback (ObjectManager *glObjects, const DrawableConfig &config)
 Read back an image.
void readback (ObjectManager *glObjects, const DrawableConfig &config, const PixelViewports &regions)
 Read back a set of images.
Images startReadback (ObjectManager *glObjects, const DrawableConfig &config, const PixelViewports &regions)
 Start reading back a set of images for this frame.
void setReady ()
 Set the frame ready.
bool isReady () const
 Test the readiness of the frame.
void waitReady (const uint32_t timeout=LB_TIMEOUT_INDEFINITE) const
 Wait for the frame to become available.
void addListener (lunchbox::Monitor< uint32_t > &listener)
 Add a listener which will be incremented when the frame is ready.
void removeListener (lunchbox::Monitor< uint32_t > &listener)
 Remove a frame listener.

Detailed Description

A holder for a frame data and related parameters.

A Frame has to be set up with a FrameData which ultimately holds the pixel data using images. Input and output frames provided by the eq::Channel are set up correctly with FrameData to connect one output frame to one ore more input frames. Some Frame parameters are (input-)frame-specific, while others are set by the output frame on its data and therefore shared between all input frames.

Definition at line 41 of file client/frame.h.


Constructor & Destructor Documentation

Construct a new frame.

Version:
1.0

Reimplemented from eq::fabric::Frame.

virtual eq::Frame::~Frame ( ) [virtual]

Destruct the frame.

Version:
1.0

Reimplemented from eq::fabric::Frame.


Member Function Documentation

void eq::Frame::addListener ( lunchbox::Monitor< uint32_t > &  listener)

Add a listener which will be incremented when the frame is ready.

Parameters:
listenerthe listener.
Version:
1.0
void eq::Frame::disableBuffer ( const Buffer  buffer)

Disable the usage of a frame buffer attachment for all images.

Parameters:
bufferthe buffer to disable.
Version:
1.0

Referenced by eVolve::Channel::frameReadback().

+ Here is the caller graph for this function:

uint32_t eq::Frame::getBuffers ( ) const
Returns:
the enabled frame buffer attachments.
Version:
1.0
Returns:
the frame's data.
Deprecated:

Referenced by eqPixelBench::Channel::configExit().

+ Here is the caller graph for this function:

const FrameData* eq::Frame::getData ( ) const
Returns:
the frame's data.
Deprecated:
Returns:
the frame's data.
Version:
1.3.2

Referenced by eVolve::Channel::configExit(), eVolve::Channel::frameAssemble(), and eVolve::Channel::frameReadback().

+ Here is the caller graph for this function:

Returns:
the frame's data.
Version:
1.4
const Images& eq::Frame::getImages ( ) const
Returns:
all images of this frame.
Version:
1.0

Referenced by eVolve::Channel::frameAssemble().

+ Here is the caller graph for this function:

const std::string& eq::Frame::getName ( ) const
Returns:
the name of the frame.
Version:
1.0

Reimplemented from eq::fabric::Frame.

uint32_t eq::Frame::getPeriod ( ) const
Returns:
the DPlex period relative to the destination channel.
Version:
1.0

Referenced by eqPly::Channel::frameAssemble().

+ Here is the caller graph for this function:

uint32_t eq::Frame::getPhase ( ) const
Returns:
the DPlex phase relative to the destination channel.
Version:
1.0
const Pixel& eq::Frame::getPixel ( ) const
Returns:
the pixel parameters relative to the destination channel.
Version:
1.0
const Range& eq::Frame::getRange ( ) const
Returns:
the database range relative to the destination channel.
Version:
1.0

Referenced by eVolve::Channel::frameAssemble().

+ Here is the caller graph for this function:

const SubPixel& eq::Frame::getSubPixel ( ) const
Returns:
the subpixel parameters wrt the destination channel.
Version:
1.0

Referenced by eqPly::Channel::frameAssemble().

+ Here is the caller graph for this function:

Returns:
the filter applied to zoomed assemble operations.
Version:
1.0
bool eq::Frame::isReady ( ) const

Test the readiness of the frame.

Returns:
true if the frame is ready, false if not.
Version:
1.0
void eq::Frame::readback ( ObjectManager glObjects,
const DrawableConfig &  config 
)

Read back an image.

The image is added to the data, existing images are retained.

Parameters:
glObjectsthe GL object manager for the current GL context.
configthe configuration of the source frame buffer.
Version:
1.0

Referenced by eVolve::Channel::frameAssemble().

+ Here is the caller graph for this function:

void eq::Frame::readback ( ObjectManager glObjects,
const DrawableConfig &  config,
const PixelViewports regions 
)

Read back a set of images.

The images are added to the data, existing images are retained.

Parameters:
glObjectsthe GL object manager for the current GL context.
configthe configuration of the source frame buffer.
regionsthe areas to read back.
Version:
1.0
void eq::Frame::removeListener ( lunchbox::Monitor< uint32_t > &  listener)

Remove a frame listener.

Parameters:
listenerthe listener.
Version:
1.0
void eq::Frame::setAlphaUsage ( const bool  useAlpha)

Set alpha usage for newly allocated images.

Version:
1.0

Referenced by eqPly::Channel::frameReadback().

+ Here is the caller graph for this function:

void eq::Frame::setData ( FrameData data)

Set the data for this frame.

Deprecated:

Set the data for this frame.

Version:
1.3.2

Referenced by eqPixelBench::Channel::Channel(), and eVolve::Channel::Channel().

+ Here is the caller graph for this function:

void eq::Frame::setQuality ( const Frame::Buffer  buffer,
const float  quality 
)

Set the minimum quality after compression.

Version:
1.0

Referenced by eVolve::Channel::frameReadback(), and eqPly::Channel::frameReadback().

+ Here is the caller graph for this function:

Set the frame ready.

Equalizer sets the frame automatically ready after readback and after network transmission.

Version:
1.0
void eq::Frame::setZoomFilter ( const ZoomFilter  zoomFilter)

Set the filter applied to zoomed assemble operations.

Version:
1.0
Images eq::Frame::startReadback ( ObjectManager glObjects,
const DrawableConfig &  config,
const PixelViewports regions 
)

Start reading back a set of images for this frame.

The newly read images are added to the data, existing images are retained. The finish for the new images has to be done by the caller. The regions are relative to the current OpenGL viewport.

Parameters:
glObjectsthe GL object manager for the current GL context.
configthe configuration of the source frame buffer.
regionsthe areas to read back.
Returns:
the new images which need finishReadback.
Version:
1.3.2
void eq::Frame::useCompressor ( const Frame::Buffer  buffer,
const uint32_t  name 
)

Sets a compressor for compression for following transmissions.

Referenced by eqPly::Channel::frameReadback().

+ Here is the caller graph for this function:

void eq::Frame::waitReady ( const uint32_t  timeout = LB_TIMEOUT_INDEFINITE) const

Wait for the frame to become available.

Version:
1.0

Referenced by eVolve::Channel::frameAssemble().

+ Here is the caller graph for this function:


The documentation for this class was generated from the following file:
Generated on Mon Nov 26 2012 14:41:50 for Equalizer 1.4.1 by  doxygen 1.7.6.1