Cleanup: remove non-existing function declarations
[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
35 public:
36         /**
37          * \brief Declaration of the virtual destructor
38          * \note resolve warning gcc 4.7
39          */
40         virtual ~Device() {}
41
42         /**
43          * \brief initialize the device
44          */
45         virtual bool initialize() { return true; }
46
47         /**
48          * \brief deinitialize the device
49          */
50         virtual void deinitialize() {}
51
52         /**
53          * \brief execute a WorkPackage
54          * \param work: the WorkPackage to execute
55          */
56         virtual void execute(WorkPackage *work) = 0;
57
58 #ifdef WITH_CXX_GUARDEDALLOC
59         MEM_CXX_CLASS_ALLOC_FUNCS("COM:Device")
60 #endif
61 };
62
63 #endif