1 /* ResidualVM - A 3D game interpreter
2  *
3  * ResidualVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  */
22 
23 #ifndef GRAPHICS_RENDERER_H
24 #define GRAPHICS_RENDERER_H
25 
26 #include "common/scummsys.h"
27 #include "common/str.h"
28 
29 namespace Graphics {
30 
31 /**
32  * @defgroup graphics_renderer Renderer
33  * @ingroup graphics
34  *
35  * @brief API for managing renderer engines.
36  *
37  * @{
38  */
39 
40 /**
41  * List of renderer types
42  *
43  * It specifies which rendering driver to use
44  */
45 enum RendererType {
46 	kRendererTypeDefault = 0,
47 	kRendererTypeOpenGL = 1,
48 	kRendererTypeOpenGLShaders = 2,
49 	kRendererTypeTinyGL = 3
50 };
51 
52 struct RendererTypeDescription {
53 	const char *code;
54 	const char *description;
55 	RendererType id;
56 };
57 
58 const RendererTypeDescription *listRendererTypes();
59 
60 /** Convert a renderer code to a RendererType enum value */
61 RendererType parseRendererTypeCode(const Common::String &code);
62 
63 /** Get a character string code from a RendererType enum value */
64 Common::String getRendererTypeCode(RendererType type);
65 
66 /** Get the best matching renderer among available renderers */
67 RendererType getBestMatchingAvailableRendererType(RendererType desired);
68  /** @} */
69 } // End of namespace Graphics
70 
71 #endif
72