Refactoring of tiles opencl implementation:
[blender.git] / source / blender / compositor / intern / COM_Device.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_Device_h
24 #define _COM_Device_h
25
26 #include "COM_WorkPackage.h"
27
28 /**
29  * @brief Abstract class for device implementations to be used by the Compositor.
30  * devices are queried, initialized and used by the WorkScheduler.
31  * work are packaged as a WorkPackage instance.
32  */
33 class Device {
34 public:
35         /**
36          * @brief initialize the device
37          */
38         virtual bool initialize() { return true; }
39
40         /**
41          * @brief deinitialize the device
42          */
43         virtual void deinitialize() {}
44
45         /**
46          * @brief execute a WorkPackage
47          * @param work the WorkPackage to execute
48          */
49         virtual void execute(WorkPackage *work) = 0;
50
51 };
52
53 #endif