Crazy Eddie's GUI System  0.8.4
CEGUI::OpenGL3Renderer Class Reference

Renderer class to interface with OpenGL. More...

+ Inheritance diagram for CEGUI::OpenGL3Renderer:
+ Collaboration diagram for CEGUI::OpenGL3Renderer:

List of all members.

Public Member Functions

OpenGL3Shader *& getShaderStandard ()
 Helper to return the reference to the pointer to the standard shader of the Renderer.
GLint getShaderStandardPositionLoc ()
 Helper to return the attribute location of the position variable in the standard shader.
GLint getShaderStandardTexCoordLoc ()
 Helper to return the attribute location of the texture coordinate variable in the standard shader.
GLint getShaderStandardColourLoc ()
 Helper to return the attribute location of the colour variable in the standard shader.
GLint getShaderStandardMatrixUniformLoc ()
 Helper to return the uniform location of the matrix variable in the standard shader.
OpenGL3StateChangeWrappergetOpenGLStateChanger ()
 Helper to get the wrapper used to check for redundant OpenGL state changes.
void beginRendering ()
 Perform any operations required to put the system into a state ready for rendering operations to begin.
void endRendering ()
 Perform any operations required to finalise rendering.
Sizef getAdjustedTextureSize (const Sizef &sz) const
 Helper to return a valid texture size according to reported OpenGL capabilities.
bool isS3TCSupported () const
 Return whether EXT_texture_compression_s3tc is supported.
void setupRenderingBlendMode (const BlendMode mode, const bool force=false)
 set the render states for the specified BlendMode.

Static Public Member Functions

static OpenGL3RendererbootstrapSystem (const int abi=CEGUI_VERSION_ABI)
 Convenience function that creates the required objects to initialise the CEGUI system.
static OpenGL3RendererbootstrapSystem (const Sizef &display_size, const int abi=CEGUI_VERSION_ABI)
 Convenience function that creates the required objects to initialise the CEGUI system.
static void destroySystem ()
 Convenience function to cleanup the CEGUI system and related objects that were created by calling the bootstrapSystem function.
static OpenGL3Renderercreate (const int abi=CEGUI_VERSION_ABI)
 Create an OpenGL3Renderer object.
static OpenGL3Renderercreate (const Sizef &display_size, const int abi=CEGUI_VERSION_ABI)
 Create an OpenGL3Renderer object.
static void destroy (OpenGL3Renderer &renderer)
 Destroy an OpenGL3Renderer object.

Detailed Description

Renderer class to interface with OpenGL.


Member Function Documentation

static OpenGL3Renderer& CEGUI::OpenGL3Renderer::bootstrapSystem ( const int  abi = CEGUI_VERSION_ABI) [static]

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:

Parameters:
abiThis must be set to CEGUI_VERSION_ABI
Returns:
Reference to the CEGUI::OpenGL3Renderer object that was created.
static OpenGL3Renderer& CEGUI::OpenGL3Renderer::bootstrapSystem ( const Sizef display_size,
const int  abi = CEGUI_VERSION_ABI 
) [static]

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:

Parameters:
display_sizeSize object describing the initial display resolution.
abiThis must be set to CEGUI_VERSION_ABI
Returns:
Reference to the CEGUI::OpenGL3Renderer object that was created.
static OpenGL3Renderer& CEGUI::OpenGL3Renderer::create ( const int  abi = CEGUI_VERSION_ABI) [static]

Create an OpenGL3Renderer object.

Parameters:
tt_typeSpecifies one of the TextureTargetType enumerated values indicating the desired TextureTarget type to be used.
abiThis must be set to CEGUI_VERSION_ABI
static OpenGL3Renderer& CEGUI::OpenGL3Renderer::create ( const Sizef display_size,
const int  abi = CEGUI_VERSION_ABI 
) [static]

Create an OpenGL3Renderer object.

Parameters:
display_sizeSize object describing the initial display resolution.
tt_typeSpecifies one of the TextureTargetType enumerated values indicating the desired TextureTarget type to be used.
abiThis must be set to CEGUI_VERSION_ABI
static void CEGUI::OpenGL3Renderer::destroy ( OpenGL3Renderer renderer) [static]

Destroy an OpenGL3Renderer object.

Parameters:
rendererThe OpenGL3Renderer object to be destroyed.
static void CEGUI::OpenGL3Renderer::destroySystem ( ) [static]

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:

Note:
If you did not initialise CEGUI by calling the bootstrapSystem function, you should not call this, but rather delete any objects you created manually.

Helper to return a valid texture size according to reported OpenGL capabilities.

Parameters:
szSize object containing input size.
Returns:
Size object containing - possibly different - output size.

Reimplemented from CEGUI::OpenGLRendererBase.

Helper to get the wrapper used to check for redundant OpenGL state changes.

Returns:
The active OpenGL state change wrapper object.

Helper to return the reference to the pointer to the standard shader of the Renderer.

Returns:
Reference to the pointer to the standard shader of the Renderer

Helper to return the attribute location of the colour variable in the standard shader.

Returns:
Attribute location of the colour variable in the standard shader

Helper to return the uniform location of the matrix variable in the standard shader.

Returns:
Uniform location of the matrix variable in the standard shader

Helper to return the attribute location of the position variable in the standard shader.

Returns:
Attribute location of the position variable in the standard shader

Helper to return the attribute location of the texture coordinate variable in the standard shader.

Returns:
Attribute location of the texture coordinate variable in the standard shader
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends