Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

BufferedImageGenerator::ImageSource Struct Reference

#include <BufferedImageGenerator.h>

List of all members.


Detailed Description

Stores information about the current frame, (not the image itself, but meta data a pointer to it).

Definition at line 14 of file BufferedImageGenerator.h.

Public Member Functions

 ImageSource ()
 constructor
 ImageSource (const ImageSource &src)
 copy constructor
ImageSourceoperator= (const ImageSource &src)
 assignment operator

Public Attributes

unsigned int width
 the width of img
unsigned int height
 the height of img
unsigned int channels
 the number of color channels in img
unsigned int frameIndex
 the serial number of the current frame (should be a unique, increasing ID)
unsigned int layer
 indicates what resolution layer of the pipeline this should be used at
MessageReceiver * receiver
 a pointer back to the MessageReceiver which got the image
unsigned char * img
 pointer to the first byte of the image buffer


Constructor & Destructor Documentation

BufferedImageGenerator::ImageSource::ImageSource  )  [inline]
 

constructor

Definition at line 16 of file BufferedImageGenerator.h.

BufferedImageGenerator::ImageSource::ImageSource const ImageSource src  )  [inline]
 

copy constructor

Definition at line 18 of file BufferedImageGenerator.h.


Member Function Documentation

ImageSource& BufferedImageGenerator::ImageSource::operator= const ImageSource src  )  [inline]
 

assignment operator

Definition at line 20 of file BufferedImageGenerator.h.


Member Data Documentation

unsigned int BufferedImageGenerator::ImageSource::channels
 

the number of color channels in img

Definition at line 23 of file BufferedImageGenerator.h.

Referenced by BufferedImageGenerator::calcImage(), operator=(), BufferedImageGenerator::processEvent(), and BufferedImageGenerator::setDimensions().

unsigned int BufferedImageGenerator::ImageSource::frameIndex
 

the serial number of the current frame (should be a unique, increasing ID)

Definition at line 24 of file BufferedImageGenerator.h.

Referenced by operator=(), and BufferedImageGenerator::processEvent().

unsigned int BufferedImageGenerator::ImageSource::height
 

the height of img

Definition at line 22 of file BufferedImageGenerator.h.

Referenced by operator=(), BufferedImageGenerator::processEvent(), and BufferedImageGenerator::setDimensions().

unsigned char* BufferedImageGenerator::ImageSource::img
 

pointer to the first byte of the image buffer

img should be stored in a channel-interleaved format, e.g. RGBRGBRGB...

Definition at line 37 of file BufferedImageGenerator.h.

Referenced by operator=(), BufferedImageGenerator::processEvent(), and BufferedImageGenerator::setDimensions().

unsigned int BufferedImageGenerator::ImageSource::layer
 

indicates what resolution layer of the pipeline this should be used at

Negative values are interpreted as "from the top", so -1 is the topmost layer, -2 is next-to-top, and so on.
Non-negative values are interpreted as direct layer values, so 0 indicates bottommost layer, 1 indicates next-to-bottom, and so on.

Definition at line 29 of file BufferedImageGenerator.h.

Referenced by BufferedImageGenerator::calcImage(), operator=(), BufferedImageGenerator::processEvent(), and BufferedImageGenerator::setDimensions().

MessageReceiver* BufferedImageGenerator::ImageSource::receiver
 

a pointer back to the MessageReceiver which got the image

If this value is non-NULL, when getImage is called, MessageReceiver::markRead() will be called on the receiver

Definition at line 33 of file BufferedImageGenerator.h.

Referenced by BufferedImageGenerator::getImage(), and operator=().

unsigned int BufferedImageGenerator::ImageSource::width
 

the width of img

Definition at line 21 of file BufferedImageGenerator.h.

Referenced by operator=(), BufferedImageGenerator::processEvent(), and BufferedImageGenerator::setDimensions().


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

Tekkotsu v2.4.1
Generated Tue Aug 16 16:34:58 2005 by Doxygen 1.4.4