Refactoring of tiles opencl implementation:
[blender.git] / source / blender / compositor / intern / COM_WorkPackage.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 class WorkPackage;
24
25 #ifndef _COM_WorkPackage_h_
26 #define _COM_WorkPackage_h_
27 class ExecutionGroup;
28 #include "COM_ExecutionGroup.h"
29
30 /**
31  * @brief contains data about work that can be scheduled
32  * @see WorkScheduler
33  */
34 class WorkPackage {
35 private:
36         /**
37          * @brief executionGroup with the operations-setup to be evaluated
38          */
39         ExecutionGroup *executionGroup;
40
41         /**
42          * @brief number of the chunk to be executed
43          */
44         unsigned int chunkNumber;
45 public:
46         /**
47          * @constructor
48          * @param group the ExecutionGroup
49          * @param chunkNumber the number of the chunk
50          */
51         WorkPackage(ExecutionGroup *group, unsigned int chunkNumber);
52
53         /**
54          * @brief get the ExecutionGroup
55          */
56         ExecutionGroup *getExecutionGroup() const { return this->executionGroup; }
57
58         /**
59          * @brief get the number of the chunk
60          */
61         unsigned int getChunkNumber() const { return this->chunkNumber; }
62 };
63
64 #endif