Fawkes API  Fawkes Development Version
scaler.cpp
1 
2 /***************************************************************************
3  * scaler.cpp - Scaler interface
4  *
5  * Generated: Thu Mar 29 11:04:03 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/scalers/scaler.h>
25 
26 namespace firevision {
27 
28 /** @class Scaler <fvutils/scalers/scaler.h>
29  * Image scaler interface.
30  * Image scalers allow for scaling images by a given factor.
31  * @author Tim Niemueller
32  *
33  * @fn void Scaler::set_scale_factor(float factor)
34  * Set scale factor.
35  * @param factor scale factor
36  *
37  * @fn void Scaler::set_original_dimensions(unsigned int width, unsigned int height)
38  * Set original image dimensions.
39  * @param width image width
40  * @param height height
41  *
42  * @fn void Scaler::set_scaled_dimensions(unsigned int width, unsigned int height)
43  * Set dimenins of scaled image buffer.
44  * @param width image width
45  * @param height height
46  *
47  * @fn void Scaler::set_original_buffer(unsigned char *buffer)
48  * Set original image buffer.
49  * @param buffer YUV 422 planar buffer
50  *
51  * @fn void Scaler::set_scaled_buffer(unsigned char *buffer)
52  * Set scaled image buffer.
53  * @param buffer YUV 422 planar buffer
54  *
55  * @fn void Scaler::scale()
56  * Scale image.
57  *
58  * @fn unsigned int Scaler::needed_scaled_width()
59  * Minimum needed width of scaled image depending on factor and original image width.
60  * @return minimum needed width
61  *
62  * @fn unsigned int Scaler::needed_scaled_height()
63  * Minimum needed height of scaled image depending on factor and original image height.
64  * @return minimum needed height
65  *
66  * @fn float Scaler::get_scale_factor()
67  * Returns the scale factor.
68  * @return the scale factor
69  */
70 
71 /** Virtual empty destructor. */
73 {
74 }
75 
76 } // end namespace firevision
firevision::Scaler::~Scaler
virtual ~Scaler()
Virtual empty destructor.
Definition: scaler.cpp:76