Merge branch 'master' into blender2.8
[blender.git] / intern / ghost / GHOST_IContext.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/GHOST_IContext.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_IContext interface class.
31  */
32
33 #ifndef __GHOST_IContext_H__
34 #define __GHOST_IContext_H__
35
36 #include "STR_String.h"
37 #include "GHOST_Types.h"
38
39
40 /**
41  * Interface for GHOST context.
42  *
43  * You can create a offscreen context (windowless) with the system's
44  * GHOST_ISystem::createOffscreenContext method.
45  * \see GHOST_ISystem#createOffscreenContext
46  *
47  * \author  ClĂ©ment Foucault
48  * \date    Feb 9, 2018
49  */
50 class GHOST_IContext
51 {
52 public:
53         /**
54          * Destructor.
55          */
56         virtual ~GHOST_IContext()
57         {
58         }
59
60         /**
61          * Activates the drawing context.
62          * \return  A boolean success indicator.
63          */
64         virtual GHOST_TSuccess activateDrawingContext() = 0;
65
66         /**
67          * Release the drawing context of the calling thread.
68          * \return  A boolean success indicator.
69          */
70         virtual GHOST_TSuccess releaseDrawingContext() = 0;
71
72 #ifdef WITH_CXX_GUARDEDALLOC
73         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IContext")
74 #endif
75 };
76
77 #endif // __GHOST_IContext_H__
78