/usr/include/cegui-0.8.7/CEGUI/RendererModules/OpenGL/GLRenderer.h is in libcegui-mk2-dev 0.8.7-1.3+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | /***********************************************************************
created: Sun Jan 11 2009
authors: Paul D Turner <paul@cegui.org.uk>
Lukas E Meindl
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIOpenGLRenderer_h_
#define _CEGUIOpenGLRenderer_h_
#include "RendererBase.h"
namespace CEGUI
{
/*!
\brief
Renderer class to interface with desktop OpenGL
*/
class OPENGL_GUIRENDERER_API OpenGLRenderer : public OpenGLRendererBase
{
public:
//! Enumeration of valid texture target types.
enum TextureTargetType
{
//! Automatically choose the best type available.
TTT_AUTO,
//! Use targets based on frame buffer objects if available, else none.
TTT_FBO,
//! Use targets based on pbuffer support if available, else none.
TTT_PBUFFER,
//! Disable texture targets.
TTT_NONE
};
/*!
\brief
Convenience function that creates the required objects to initialise the
CEGUI system.
The created Renderer will use the current OpenGL viewport as it's
default surface size.
This will create and initialise the following objects for you:
- CEGUI::OpenGLRenderer
- CEGUI::DefaultResourceProvider
- CEGUI::System
\param tt_type
Specifies one of the TextureTargetType enumerated values indicating the
desired TextureTarget type to be used. Defaults to TTT_AUTO.
\param abi
This must be set to CEGUI_VERSION_ABI
\return
Reference to the CEGUI::OpenGLRenderer object that was created.
*/
static OpenGLRenderer& bootstrapSystem(
const TextureTargetType tt_type = TTT_AUTO,
const int abi = CEGUI_VERSION_ABI);
/*!
\brief
Convenience function that creates the required objects to initialise the
CEGUI system.
The created Renderer will use the current OpenGL viewport as it's
default surface size.
This will create and initialise the following objects for you:
- CEGUI::OpenGLRenderer
- CEGUI::DefaultResourceProvider
- CEGUI::System
\param display_size
Size object describing the initial display resolution.
\param tt_type
Specifies one of the TextureTargetType enumerated values indicating the
desired TextureTarget type to be used. Defaults to TTT_AUTO.
\param abi
This must be set to CEGUI_VERSION_ABI
\return
Reference to the CEGUI::OpenGLRenderer object that was created.
*/
static OpenGLRenderer& bootstrapSystem(const Sizef& display_size,
const TextureTargetType tt_type = TTT_AUTO,
const int abi = CEGUI_VERSION_ABI);
/*!
\brief
Convenience function to cleanup the CEGUI system and related objects
that were created by calling the bootstrapSystem function.
This function will destroy the following objects for you:
- CEGUI::System
- CEGUI::DefaultResourceProvider
- CEGUI::OpenGLRenderer
\note
If you did not initialise CEGUI by calling the bootstrapSystem function,
you should \e not call this, but rather delete any objects you created
manually.
*/
static void destroySystem();
/*!
\brief
Create an OpenGLRenderer object.
\param tt_type
Specifies one of the TextureTargetType enumerated values indicating the
desired TextureTarget type to be used.
\param abi
This must be set to CEGUI_VERSION_ABI
*/
static OpenGLRenderer& create(const TextureTargetType tt_type = TTT_AUTO,
const int abi = CEGUI_VERSION_ABI);
/*!
\brief
Create an OpenGLRenderer object.
\param display_size
Size object describing the initial display resolution.
\param tt_type
Specifies one of the TextureTargetType enumerated values indicating the
desired TextureTarget type to be used.
\param abi
This must be set to CEGUI_VERSION_ABI
*/
static OpenGLRenderer& create(const Sizef& display_size,
const TextureTargetType tt_type = TTT_AUTO,
const int abi = CEGUI_VERSION_ABI);
/*!
\brief
Destroy an OpenGLRenderer object.
\param renderer
The OpenGLRenderer object to be destroyed.
*/
static void destroy(OpenGLRenderer& renderer);
// base class overrides / abstract function implementations
void beginRendering();
void endRendering();
bool isS3TCSupported() const;
void setupRenderingBlendMode(const BlendMode mode,
const bool force = false);
void setViewProjectionMatrix(const mat4Pimpl* viewProjectionMatrix);
protected:
//! Overrides
OpenGLGeometryBufferBase* createGeometryBuffer_impl();
TextureTarget* createTextureTarget_impl();
void initialiseRendererIDString();
/*!
\brief
Constructor for OpenGL Renderer objects
\param tt_type
Specifies one of the TextureTargetType enumerated values indicating the
desired TextureTarget type to be used.
*/
OpenGLRenderer(const TextureTargetType tt_type);
/*!
\brief
Constructor for OpenGL Renderer objects.
\param display_size
Size object describing the initial display resolution.
\param tt_type
Specifies one of the TextureTargetType enumerated values indicating the
desired TextureTarget type to be used.
*/
OpenGLRenderer(const Sizef& display_size, const TextureTargetType tt_type);
/*!
\brief
Destructor for OpenGLRenderer objects
*/
virtual ~OpenGLRenderer();
//! init the extra GL states enabled via enableExtraStateSettings
void setupExtraStates();
//! cleanup the extra GL states enabled via enableExtraStateSettings
void cleanupExtraStates();
//! initialise OGLTextureTargetFactory that will generate TextureTargets
void initialiseTextureTargetFactory(const TextureTargetType tt_type);
void initialiseGLExtensions();
//! pointer to a helper that creates TextureTargets supported by the system.
OGLTextureTargetFactory* d_textureTargetFactory;
};
}
#endif
|