Fawkes API  Fawkes Development Version
firevision::Reader Class Reference

Image reader interface. More...

#include <>>

Inheritance diagram for firevision::Reader:

List of all members.

Public Member Functions

virtual ~Reader ()
 Virtual empty destructor.
virtual void set_buffer (unsigned char *yuv422planar_buffer)=0
 Set buffer that the read image should be written to.
virtual colorspace_t colorspace ()=0
 Get colorspace from the just read image.
virtual unsigned int pixel_width ()=0
 Get width of read image in pixels.
virtual unsigned int pixel_height ()=0
 Get height of read image in pixels.
virtual void read ()=0
 Read data from file.

Detailed Description

Image reader interface.


Constructor & Destructor Documentation

firevision::Reader::~Reader ( ) [virtual]

Virtual empty destructor.

Definition at line 56 of file reader.cpp.


Member Function Documentation

colorspace_t firevision::Reader::colorspace ( ) [pure virtual]

Get colorspace from the just read image.

Returns:
colorspace

Implemented in firevision::JpegReader, firevision::FvRawReader, firevision::PNGReader, and firevision::PNMReader.

unsigned int firevision::Reader::pixel_height ( ) [pure virtual]

Get height of read image in pixels.

Returns:
height of image

Implemented in firevision::JpegReader, firevision::FvRawReader, firevision::PNGReader, and firevision::PNMReader.

unsigned int firevision::Reader::pixel_width ( ) [pure virtual]

Get width of read image in pixels.

Returns:
width of image

Implemented in firevision::JpegReader, firevision::FvRawReader, firevision::PNGReader, and firevision::PNMReader.

void firevision::Reader::read ( ) [pure virtual]
void firevision::Reader::set_buffer ( unsigned char *  yuv422planar_buffer) [pure virtual]

Set buffer that the read image should be written to.

Parameters:
yuv422planar_bufferbuffer to write image to. The reader must ensure that it does the proper conversion (if needed) to YUV 422 planar format.

Implemented in firevision::JpegReader, firevision::FvRawReader, firevision::PNGReader, and firevision::PNMReader.


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