Fawkes API
Fawkes Development Version
|
00001 00002 /*************************************************************************** 00003 * scaler.cpp - Scaler interface 00004 * 00005 * Generated: Thu Mar 29 11:04:03 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/scalers/scaler.h> 00025 00026 namespace firevision { 00027 #if 0 /* just to make Emacs auto-indent happy */ 00028 } 00029 #endif 00030 00031 /** @class Scaler <fvutils/scalers/scaler.h> 00032 * Image scaler interface. 00033 * Image scalers allow for scaling images by a given factor. 00034 * @author Tim Niemueller 00035 * 00036 * @fn void Scaler::set_scale_factor(float factor) 00037 * Set scale factor. 00038 * @param factor scale factor 00039 * 00040 * @fn void Scaler::set_original_dimensions(unsigned int width, unsigned int height) 00041 * Set original image dimensions. 00042 * @param width image width 00043 * @param height height 00044 * 00045 * @fn void Scaler::set_scaled_dimensions(unsigned int width, unsigned int height) 00046 * Set dimenins of scaled image buffer. 00047 * @param width image width 00048 * @param height height 00049 * 00050 * @fn void Scaler::set_original_buffer(unsigned char *buffer) 00051 * Set original image buffer. 00052 * @param buffer YUV 422 planar buffer 00053 * 00054 * @fn void Scaler::set_scaled_buffer(unsigned char *buffer) 00055 * Set scaled image buffer. 00056 * @param buffer YUV 422 planar buffer 00057 * 00058 * @fn void Scaler::scale() 00059 * Scale image. 00060 * 00061 * @fn unsigned int Scaler::needed_scaled_width() 00062 * Minimum needed width of scaled image depending on factor and original image width. 00063 * @return minimum needed width 00064 * 00065 * @fn unsigned int Scaler::needed_scaled_height() 00066 * Minimum needed height of scaled image depending on factor and original image height. 00067 * @return minimum needed height 00068 * 00069 * @fn float Scaler::get_scale_factor() 00070 * Returns the scale factor. 00071 * @return the scale factor 00072 */ 00073 00074 /** Virtual empty destructor. */ 00075 Scaler::~Scaler() 00076 { 00077 } 00078 00079 } // end namespace firevision