ConvolutionFilter.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCORECONVOLUTIONFILTER_H
00029 #define ROCKETCORECONVOLUTIONFILTER_H
00030 
00031 namespace Rocket {
00032 namespace Core {
00033 
00041 class ConvolutionFilter
00042 {
00043 public:
00044         enum FilterOperation
00045         {
00046                 // The result is the median value of all the filtered pixels.
00047                 MEDIAN,
00048                 // The result is the smallest value of all filtered pixels.
00049                 DILATION,
00050                 // The result is the largest value of all the filtered pixels.
00051                 EROSION
00052         };
00053 
00054         ConvolutionFilter();
00055         ~ConvolutionFilter();
00056 
00060         bool Initialise(int kernel_size, FilterOperation operation = MEDIAN);
00061 
00065         float* operator[](int index);
00066 
00076         void Run(byte* destination, const Vector2i& destination_dimensions, int destination_stride, const byte* source, const Vector2i& source_dimensions, const Vector2i& source_offset) const;
00077 
00078 private:
00079         int kernel_size;
00080         float* kernel;
00081 
00082         FilterOperation operation;
00083 };
00084 
00085 }
00086 }
00087 
00088 #endif
00089