Crazy Eddie's GUI System  ${CEGUI_VERSION}
OpenGLRendererBase_wrapper Struct Reference
+ Inheritance diagram for OpenGLRendererBase_wrapper:
+ Collaboration diagram for OpenGLRendererBase_wrapper:

Public Member Functions

 OpenGLRendererBase_wrapper (::CEGUI::Sizef const &display_size)
 
virtual ::CEGUI::OpenGLGeometryBufferBasecreateGeometryBuffer_impl ()
 return some appropriate OpenGLGeometryBufferBase subclass instance.
 
virtual ::CEGUI::TextureTargetcreateTextureTarget ()
 Create a TextureTarget that can be used to cache imagery; this is a RenderTarget that does not lose it's content from one frame to another. More...
 
::CEGUI::TextureTargetdefault_createTextureTarget ()
 
virtual ::CEGUI::TextureTargetcreateTextureTarget_impl ()
 return some appropriate TextureTarget subclass instance.
 
virtual void destroyAllGeometryBuffers ()
 Destroy all GeometryBuffer objects created by this Renderer.
 
void default_destroyAllGeometryBuffers ()
 
virtual void destroyAllTextureTargets ()
 Destory all TextureTarget objects created by this Renderer.
 
void default_destroyAllTextureTargets ()
 
virtual void destroyAllTextures ()
 Destroy all Texture objects created by this Renderer.
 
void default_destroyAllTextures ()
 
virtual void destroyGeometryBuffer (::CEGUI::GeometryBuffer const &buffer)
 
void default_destroyGeometryBuffer (::CEGUI::GeometryBuffer const &buffer)
 
virtual void destroyTexture (::CEGUI::Texture &texture)
 
void default_destroyTexture (::CEGUI::Texture &texture)
 
virtual void destroyTexture (::CEGUI::String const &name)
 
void default_destroyTexture (::CEGUI::String const &name)
 
virtual void destroyTextureTarget (::CEGUI::TextureTarget *target)
 
void default_destroyTextureTarget (::CEGUI::TextureTarget *target)
 
virtual ::CEGUI::Sizef getAdjustedTextureSize (::CEGUI::Sizef const &sz) const
 
::CEGUI::Sizef default_getAdjustedTextureSize (::CEGUI::Sizef const &sz) const
 
virtual ::CEGUI::uint getMaxTextureSize () const
 Return the pixel size of the maximum supported texture. More...
 
::CEGUI::uint default_getMaxTextureSize () const
 
void initialiseDisplaySizeWithViewportSize ()
 
void initialiseMaxTextureSize ()
 
virtual bool isS3TCSupported () const
 
virtual bool isTextureDefined (::CEGUI::String const &name) const
 
bool default_isTextureDefined (::CEGUI::String const &name) const
 
virtual void setDisplaySize (::CEGUI::Sizef const &sz)
 
void default_setDisplaySize (::CEGUI::Sizef const &sz)
 
virtual void setupRenderingBlendMode (::CEGUI::BlendMode const mode, bool const force=false)
 
virtual void beginRendering ()
 Perform any operations required to put the system into a state ready for rendering operations to begin.
 
virtual void endRendering ()
 Perform any operations required to finalise rendering.
 
- Public Member Functions inherited from CEGUI::OpenGLRendererBase
RenderTargetgetDefaultRenderTarget ()
 Returns the default RenderTarget object. The default render target is is typically one that targets the entire screen (or rendering window). More...
 
GeometryBuffercreateGeometryBuffer ()
 Create a new GeometryBuffer and return a reference to it. You should remove the GeometryBuffer from any RenderQueues and call destroyGeometryBuffer when you want to destroy the GeometryBuffer. More...
 
void destroyGeometryBuffer (const GeometryBuffer &buffer)
 Destroy a GeometryBuffer that was returned when calling the createGeometryBuffer function. Before destroying any GeometryBuffer you should ensure that it has been removed from any RenderQueue that was using it. More...
 
void destroyTextureTarget (TextureTarget *target)
 Function that cleans up TextureTarget objects created with the createTextureTarget function. More...
 
TexturecreateTexture (const String &name)
 Create a 'null' Texture object. More...
 
TexturecreateTexture (const String &name, const String &filename, const String &resourceGroup)
 Create a Texture object using the given image file. More...
 
TexturecreateTexture (const String &name, const Sizef &size)
 Create a Texture object with the given pixel dimensions as specified by size. More...
 
void destroyTexture (Texture &texture)
 Destroy a Texture object that was previously created by calling the createTexture functions. More...
 
void destroyTexture (const String &name)
 Destroy a Texture object that was previously created by calling the createTexture functions. More...
 
TexturegetTexture (const String &name) const
 Return a Texture object that was previously created by calling the createTexture functions. More...
 
bool isTextureDefined (const String &name) const
 Return whether a texture with the given name exists.
 
void setDisplaySize (const Sizef &sz)
 Set the size of the display or host window in pixels for this Renderer object. More...
 
const SizefgetDisplaySize () const
 Return the size of the display or host window in pixels. More...
 
const Vector2fgetDisplayDPI () const
 Return the resolution of the display or host window in dots per inch. More...
 
const StringgetIdentifierString () const
 Return identification string for the renderer module. More...
 
TexturecreateTexture (const String &name, GLuint tex, const Sizef &sz)
 Create a texture that uses an existing OpenGL texture with the specified size. Note that it is your responsibility to ensure that the OpenGL texture is valid and that the specified size is accurate. More...
 
void enableExtraStateSettings (bool setting)
 Tells the renderer to initialise some extra states beyond what it directly needs itself for CEGUI. More...
 
void grabTextures ()
 Grabs all the loaded textures from Texture RAM and stores them in a local data buffer. This function invalidates all textures, and restoreTextures must be called before any CEGUI rendering is done for predictable results.
 
void restoreTextures ()
 Restores all the loaded textures from the local data buffers previously created by 'grabTextures'.
 
virtual Sizef getAdjustedTextureSize (const Sizef &sz) const
 Helper to return a valid texture size according to reported OpenGL capabilities. More...
 
virtual void setupRenderingBlendMode (const BlendMode mode, const bool force=false)=0
 set the render states for the specified BlendMode.
 
virtual const mat4PimplgetViewProjectionMatrix ()
 Helper to return view projection matrix. More...
 
virtual void setViewProjectionMatrix (const mat4Pimpl *viewProjectionMatrix)
 Helper to set the view projection matrix. More...
 
const CEGUI::RectfgetActiveViewPort ()
 Helper to get the viewport. More...
 
void setActiveRenderTarget (RenderTarget *renderTarget)
 Helper to set the active render target. More...
 
RenderTargetgetActiveRenderTarget ()
 Helper to get the active render target. More...
 
bool isTexCoordSystemFlipped () const
 Returns if the texture coordinate system is vertically flipped or not. The original of a texture coordinate system is typically located either at the the top-left or the bottom-left. CEGUI, Direct3D and most rendering engines assume it to be on the top-left. OpenGL assumes it to be at the bottom left. More...
 
RenderTargetgetDefaultRenderTarget ()
 Returns the default RenderTarget object. The default render target is is typically one that targets the entire screen (or rendering window). More...
 
GeometryBuffercreateGeometryBuffer ()
 Create a new GeometryBuffer and return a reference to it. You should remove the GeometryBuffer from any RenderQueues and call destroyGeometryBuffer when you want to destroy the GeometryBuffer. More...
 
void destroyGeometryBuffer (const GeometryBuffer &buffer)
 Destroy a GeometryBuffer that was returned when calling the createGeometryBuffer function. Before destroying any GeometryBuffer you should ensure that it has been removed from any RenderQueue that was using it. More...
 
void destroyAllGeometryBuffers ()
 Destroy all GeometryBuffer objects created by this Renderer.
 
TextureTargetcreateTextureTarget ()
 Create a TextureTarget that can be used to cache imagery; this is a RenderTarget that does not lose it's content from one frame to another. More...
 
void destroyTextureTarget (TextureTarget *target)
 Function that cleans up TextureTarget objects created with the createTextureTarget function. More...
 
void destroyAllTextureTargets ()
 Destory all TextureTarget objects created by this Renderer.
 
TexturecreateTexture (const String &name)
 Create a 'null' Texture object. More...
 
TexturecreateTexture (const String &name, const String &filename, const String &resourceGroup)
 Create a Texture object using the given image file. More...
 
TexturecreateTexture (const String &name, const Sizef &size)
 Create a Texture object with the given pixel dimensions as specified by size. More...
 
void destroyTexture (Texture &texture)
 Destroy a Texture object that was previously created by calling the createTexture functions. More...
 
void destroyTexture (const String &name)
 Destroy a Texture object that was previously created by calling the createTexture functions. More...
 
void destroyAllTextures ()
 Destroy all Texture objects created by this Renderer.
 
TexturegetTexture (const String &name) const
 Return a Texture object that was previously created by calling the createTexture functions. More...
 
bool isTextureDefined (const String &name) const
 Return whether a texture with the given name exists.
 
void setDisplaySize (const Sizef &sz)
 Set the size of the display or host window in pixels for this Renderer object. More...
 
const SizefgetDisplaySize () const
 Return the size of the display or host window in pixels. More...
 
const Vector2fgetDisplayDPI () const
 Return the resolution of the display or host window in dots per inch. More...
 
uint getMaxTextureSize () const
 Return the pixel size of the maximum supported texture. More...
 
const StringgetIdentifierString () const
 Return identification string for the renderer module. More...
 
TexturecreateTexture (const String &name, GLuint tex, const Sizef &sz)
 Create a texture that uses an existing OpenGL texture with the specified size. Note that it is your responsibility to ensure that the OpenGL texture is valid and that the specified size is accurate. More...
 
void enableExtraStateSettings (bool setting)
 Tells the renderer to initialise some extra states beyond what it directly needs itself for CEGUI. More...
 
void grabTextures ()
 Grabs all the loaded textures from Texture RAM and stores them in a local data buffer. This function invalidates all textures, and restoreTextures must be called before any CEGUI rendering is done for predictable results.
 
void restoreTextures ()
 Restores all the loaded textures from the local data buffers previously created by 'grabTextures'.
 
virtual Sizef getAdjustedTextureSize (const Sizef &sz) const
 Helper to return a valid texture size according to reported OpenGL capabilities. More...
 
virtual void setupRenderingBlendMode (const BlendMode mode, const bool force=false)=0
 set the render states for the specified BlendMode.
 
virtual const mat4PimplgetViewProjectionMatrix ()
 Helper to return view projection matrix. More...
 
virtual void setViewProjectionMatrix (const mat4Pimpl *viewProjectionMatrix)
 Helper to set the view projection matrix. More...
 
const CEGUI::RectfgetActiveViewPort ()
 Helper to get the viewport. More...
 
void setActiveRenderTarget (RenderTarget *renderTarget)
 Helper to set the active render target. More...
 
RenderTargetgetActiveRenderTarget ()
 Helper to get the active render target. More...
 
bool isTexCoordSystemFlipped () const
 Returns if the texture coordinate system is vertically flipped or not. The original of a texture coordinate system is typically located either at the the top-left or the bottom-left. CEGUI, Direct3D and most rendering engines assume it to be on the top-left. OpenGL assumes it to be at the bottom left. More...
 
- Public Member Functions inherited from CEGUI::Renderer
virtual ~Renderer ()
 Destructor.
 
virtual ~Renderer ()
 Destructor.
 

Static Public Member Functions

static void logTextureCreation (::CEGUI::String const &name)
 
static void logTextureDestruction (::CEGUI::String const &name)
 
- Static Public Member Functions inherited from CEGUI::OpenGLRendererBase
static float getNextPOTSize (const float f)
 Utility function that will return f if it's a power of two, or the next power of two up from f if it's not.
 
static float getNextPOTSize (const float f)
 Utility function that will return f if it's a power of two, or the next power of two up from f if it's not.
 

Additional Inherited Members

- Protected Types inherited from CEGUI::OpenGLRendererBase
typedef std::vector< TextureTarget * > TextureTargetList
 container type used to hold TextureTargets we create.
 
typedef std::vector< OpenGLGeometryBufferBase * > GeometryBufferList
 container type used to hold GeometryBuffers created.
 
typedef std::map< String, OpenGLTexture *, StringFastLessCompare CEGUI_MAP_ALLOC(String, OpenGLTexture *)> TextureMap
 container type used to hold Textures we create.
 
typedef std::vector< TextureTarget * > TextureTargetList
 container type used to hold TextureTargets we create.
 
typedef std::vector< OpenGLGeometryBufferBase * > GeometryBufferList
 container type used to hold GeometryBuffers created.
 
typedef std::map< String, OpenGLTexture *, StringFastLessCompare CEGUI_MAP_ALLOC(String, OpenGLTexture *)> TextureMap
 container type used to hold Textures we create.
 
- Protected Member Functions inherited from CEGUI::OpenGLRendererBase
 OpenGLRendererBase (const Sizef &display_size)
 Constructor. More...
 
 OpenGLRendererBase (bool set_glew_experimental)
 
 OpenGLRendererBase (const Sizef &display_size, bool set_glew_experimental)
 Constructor. More...
 
void init (bool init_glew=false, bool set_glew_experimental=false)
 
virtual ~OpenGLRendererBase ()
 Destructor!
 
void initialiseMaxTextureSize ()
 helper to set (rough) max texture size.
 
void initialiseDisplaySizeWithViewportSize ()
 helper to set display size with current viewport size.
 
 OpenGLRendererBase (const Sizef &display_size)
 Constructor. More...
 
 OpenGLRendererBase (bool set_glew_experimental)
 
 OpenGLRendererBase (const Sizef &display_size, bool set_glew_experimental)
 Constructor. More...
 
void init (bool init_glew=false, bool set_glew_experimental=false)
 
virtual ~OpenGLRendererBase ()
 Destructor!
 
void initialiseMaxTextureSize ()
 helper to set (rough) max texture size.
 
void initialiseDisplaySizeWithViewportSize ()
 helper to set display size with current viewport size.
 
- Static Protected Member Functions inherited from CEGUI::OpenGLRendererBase
static void logTextureCreation (const String &name)
 helper to safely log the creation of a named texture
 
static void logTextureDestruction (const String &name)
 helper to safely log the destruction of a named texture
 
static void logTextureCreation (const String &name)
 helper to safely log the creation of a named texture
 
static void logTextureDestruction (const String &name)
 helper to safely log the destruction of a named texture
 
- Protected Attributes inherited from CEGUI::OpenGLRendererBase
Sizef d_displaySize
 What the renderer considers to be the current display size.
 
Vector2f d_displayDPI
 What the renderer considers to be the current display DPI resolution.
 
RenderTargetd_defaultTarget
 The default RenderTarget.
 
TextureTargetList d_textureTargets
 Container used to track texture targets.
 
GeometryBufferList d_geometryBuffers
 Container used to track geometry buffers.
 
TextureMap d_textures
 Container used to track textures.
 
uint d_maxTextureSize
 What the renderer thinks the max texture size is.
 
bool d_initExtraStates
 option of whether to initialise extra states that may not be at default
 
BlendMode d_activeBlendMode
 What blend mode we think is active.
 
mat4Pimpld_viewProjectionMatrix
 View projection matrix.
 
RenderTargetd_activeRenderTarget
 The active RenderTarget.
 
- Static Protected Attributes inherited from CEGUI::OpenGLRendererBase
static String d_rendererID
 String holding the renderer identification text.
 

Member Function Documentation

§ createTextureTarget()

virtual ::CEGUI::TextureTarget* OpenGLRendererBase_wrapper::createTextureTarget ( )
inlinevirtual

Create a TextureTarget that can be used to cache imagery; this is a RenderTarget that does not lose it's content from one frame to another.

If the renderer is unable to offer such a thing, 0 should be returned.

Returns
Pointer to a TextureTarget object that is suitable for caching imagery, or 0 if the renderer is unable to offer such a thing.

Reimplemented from CEGUI::OpenGLRendererBase.

References CEGUI::OpenGLRendererBase::createTextureTarget().

§ getMaxTextureSize()

virtual ::CEGUI::uint OpenGLRendererBase_wrapper::getMaxTextureSize ( ) const
inlinevirtual

Return the pixel size of the maximum supported texture.

Returns
Size of the maximum supported texture in pixels.

Reimplemented from CEGUI::OpenGLRendererBase.

References CEGUI::OpenGLRendererBase::getMaxTextureSize(), CEGUI::OpenGLRendererBase::initialiseDisplaySizeWithViewportSize(), and CEGUI::OpenGLRendererBase::initialiseMaxTextureSize().

§ isS3TCSupported()

virtual bool OpenGLRendererBase_wrapper::isS3TCSupported ( ) const
inlinevirtual