reader.cpp

00001 
00002 /***************************************************************************
00003  *  reader.cpp - Reader interface
00004  *
00005  *  Generated: Thu Mar 29 01:21:19 2007
00006  *  Copyright  2005-2007  Tim Niemueller [www.niemueller.de]
00007  *
00008  ****************************************************************************/
00009 
00010 /*  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2 of the License, or
00013  *  (at your option) any later version. A runtime exception applies to
00014  *  this software (see LICENSE.GPL_WRE file mentioned below for details).
00015  *
00016  *  This program is distributed in the hope that it will be useful,
00017  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  *  GNU Library General Public License for more details.
00020  *
00021  *  Read the full text in the LICENSE.GPL_WRE file in the doc directory.
00022  */
00023 
00024 #include <fvutils/readers/reader.h>
00025 
00026 namespace firevision {
00027 #if 0 /* just to make Emacs auto-indent happy */
00028 }
00029 #endif
00030 
00031 /** @class Reader <fvutils/readers/reader.h>
00032  * Image reader interface.
00033  *
00034  * @fn void Reader::set_buffer(unsigned char *yuv422planar_buffer)
00035  * Set buffer that the read image should be written to.
00036  * @param yuv422planar_buffer buffer to write image to. The reader must ensure
00037  * that it does the proper conversion (if needed) to YUV 422 planar format.
00038  *
00039  * @fn colorspace_t Reader::colorspace()
00040  * Get colorspace from the just read image.
00041  * @return colorspace
00042  *
00043  * @fn unsigned int Reader::pixel_width()
00044  * Get width of read image in pixels.
00045  * @return width of image
00046  *
00047  * @fn unsigned int Reader::pixel_height()
00048  * Get height of read image in pixels.
00049  * @return height of image
00050  *
00051  * @fn void Reader::read()
00052  * Read data from file.
00053  */
00054 
00055 /** Virtual empty destructor. */
00056 Reader::~Reader()
00057 {
00058 }
00059 
00060 } // end namespace firevision

Generated on Tue Feb 22 13:32:16 2011 for Fawkes API by  doxygen 1.4.7