BufferedImageGenerator::ImageSource Struct Reference

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

#include <BufferedImageGenerator.h>

---

Detailed Description

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

Definition at line 12 of file BufferedImageGenerator.h.

List of all members.

Public Member Functions
	ImageSource ()
	constructor
	ImageSource (const ImageSource &src)
	copy constructor
ImageSource &	operator= (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
unsigned char *	img
	pointer to the first byte of the image buffer

---

Constructor & Destructor Documentation

BufferedImageGenerator::ImageSource::ImageSource

(

)

constructor

Definition at line 14 of file BufferedImageGenerator.h.

BufferedImageGenerator::ImageSource::ImageSource

(

const ImageSource &

src

)

copy constructor

Definition at line 16 of file BufferedImageGenerator.h.

---

Member Function Documentation

ImageSource& BufferedImageGenerator::ImageSource::operator=

(

const ImageSource &

src

)

assignment operator

Definition at line 18 of file BufferedImageGenerator.h.

---

Member Data Documentation

unsigned int BufferedImageGenerator::ImageSource::channels

the number of color channels in img

Definition at line 21 of file BufferedImageGenerator.h.

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

unsigned int BufferedImageGenerator::ImageSource::frameIndex

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

Definition at line 22 of file BufferedImageGenerator.h.

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

unsigned int BufferedImageGenerator::ImageSource::height

the height of img

Definition at line 20 of file BufferedImageGenerator.h.

Referenced by BufferedImageGenerator::doEvent(), operator=(), 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 31 of file BufferedImageGenerator.h.

Referenced by BufferedImageGenerator::doEvent(), operator=(), 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 27 of file BufferedImageGenerator.h.

Referenced by BufferedImageGenerator::calcImage(), BufferedImageGenerator::createImageCache(), BufferedImageGenerator::doEvent(), BufferedImageGenerator::downsampleImage(), operator=(), BufferedImageGenerator::setDimensions(), and BufferedImageGenerator::upsampleImage().

unsigned int BufferedImageGenerator::ImageSource::width

the width of img

Definition at line 19 of file BufferedImageGenerator.h.

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

---

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

• BufferedImageGenerator.h