Fawkes API Fawkes Development Version
reader.cpp
1
2/***************************************************************************
3 * reader.cpp - Reader interface
4 *
5 * Generated: Thu Mar 29 01:21:19 2007
6 * Copyright 2005-2007 Tim Niemueller [www.niemueller.de]
7 *
8 ****************************************************************************/
9
10/* This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version. A runtime exception applies to
14 * this software (see LICENSE.GPL_WRE file mentioned below for details).
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Library General Public License for more details.
20 *
21 * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22 */
23
24#include <fvutils/readers/reader.h>
25
26namespace firevision {
27
28/** @class Reader <fvutils/readers/reader.h>
29 * Image reader interface.
30 *
31 * @fn void Reader::set_buffer(unsigned char *yuv422planar_buffer)
32 * Set buffer that the read image should be written to.
33 * @param yuv422planar_buffer buffer to write image to. The reader must ensure
34 * that it does the proper conversion (if needed) to YUV 422 planar format.
35 *
36 * @fn colorspace_t Reader::colorspace()
37 * Get colorspace from the just read image.
38 * @return colorspace
39 *
40 * @fn unsigned int Reader::pixel_width()
41 * Get width of read image in pixels.
42 * @return width of image
43 *
44 * @fn unsigned int Reader::pixel_height()
45 * Get height of read image in pixels.
46 * @return height of image
47 *
48 * @fn void Reader::read()
49 * Read data from file.
50 */
51
52/** Virtual empty destructor. */
54{
55}
56
57} // end namespace firevision
virtual ~Reader()
Virtual empty destructor.
Definition: reader.cpp:53