Merge branch 'blender2.7'
[blender.git] / intern / ghost / GHOST_IContext.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup GHOST
22  * Declaration of GHOST_IContext interface class.
23  */
24
25 #ifndef __GHOST_IContext_H__
26 #define __GHOST_IContext_H__
27
28 #include "STR_String.h"
29 #include "GHOST_Types.h"
30
31
32 /**
33  * Interface for GHOST context.
34  *
35  * You can create a offscreen context (windowless) with the system's
36  * GHOST_ISystem::createOffscreenContext method.
37  * \see GHOST_ISystem#createOffscreenContext
38  */
39 class GHOST_IContext
40 {
41 public:
42         /**
43          * Destructor.
44          */
45         virtual ~GHOST_IContext()
46         {
47         }
48
49         /**
50          * Activates the drawing context.
51          * \return  A boolean success indicator.
52          */
53         virtual GHOST_TSuccess activateDrawingContext() = 0;
54
55         /**
56          * Release the drawing context of the calling thread.
57          * \return  A boolean success indicator.
58          */
59         virtual GHOST_TSuccess releaseDrawingContext() = 0;
60
61 #ifdef WITH_CXX_GUARDEDALLOC
62         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IContext")
63 #endif
64 };
65
66 #endif // __GHOST_IContext_H__