code cleanup: spelling,
[blender.git] / source / blender / compositor / operations / COM_PixelateOperation.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor:
19  *              Jeroen Bakker
20  *              Monique Dewanchand
21  */
22
23 #ifndef _COM_PixelateOperation_h_
24 #define _COM_PixelateOperation_h_
25
26 #include "COM_NodeOperation.h"
27
28 /**
29  * @brief Pixelate operation
30  *
31  * The Tile compositor is by default sub-pixel accurate.
32  * For some setups you don want this.
33  * This operation will remove the sub-pixel accuracy
34  */
35 class PixelateOperation : public NodeOperation {
36 private:
37         /**
38          * @brief cached reference to the input operation
39          */
40         SocketReader *m_inputOperation;
41 public:
42         /**
43          * @brief PixelateOperation
44          * @param dataType the datatype to create this operator for (saves datatype conversions)
45          */
46         PixelateOperation(DataType dataType);
47
48         /**
49          * @brief initialization of the execution
50          */
51         void initExecution();
52
53         /**
54          * @brief de-initialization of the execution
55          */
56         void deinitExecution();
57
58         /**
59          * @brief executePixel
60          * @param output result
61          * @param x x-coordinate
62          * @param y y-coordinate
63          * @param sampler sampler
64          */
65         void executePixel(float output[4], float x, float y, PixelSampler sampler);
66 };
67
68 #endif