Spinning Topp Logo BlackTopp Studios
inc
oglrendersyshelper.h.cpp
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine 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 The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _graphicsoglrendersyshelper_h_cpp
41 #define _graphicsoglrendersyshelper_h_cpp
42 
43 #include "datatypes.h"
44 #include "Graphics/graphicsenumerations.h"
45 
46 namespace Mezzanine
47 {
48  namespace Graphics
49  {
50  /// @brief Creates the rendersystem and populates internal structures appropriately for use.
52  /// @brief Shutsdown the rendersystem and removes it from internal structures.
53  /// @note Currently does nothing because Ogres shutdown sequence is bad.
55 
56  /// @brief Gets the Mezzanine type for the internal GL render system.
57  /// @return Returns the RenderSystem enum value representing this type of internal render system.
59  /// @brief Gets the long name of the GL render system.
60  /// @return Returns a String containing the long name of the GL render system.
62  /// @brief Gets the short name of the GL render system.
63  /// @return Returns a String containing the short name of the GL render system.
65  }//Graphics
66 }//Mezzanine
67 
68 #endif
String GetShortenedGLRenderSystemName()
Gets the short name of the GL render system.
void CreateGLRenderSystem()
Creates the rendersystem and populates internal structures appropriately for use. ...
RenderSystem
Used primarily by the graphics manager class during initialization.
All the definitions for datatypes as well as some basic conversion functions are defined here...
String GetGLRenderSystemName()
Gets the long name of the GL render system.
Graphics::RenderSystem GetGLRenderSystemType()
Gets the Mezzanine type for the internal GL render system.
void DestroyGLRenderSystem()
Shutsdown the rendersystem and removes it from internal structures.
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159