Inheritance diagram for OgreRenderer_wrapper:

Collaboration diagram for OgreRenderer_wrapper:

Public Member Functions
	OgreRenderer_wrapper (::Ogre::RenderTarget &target)

virtual void	beginRendering ()
	Perform any operations required to put the system into a state ready for rendering operations to begin.

void	default_beginRendering ()

void	checkOgreInitialised ()

void	cleanupShaders ()

void	constructor_impl (::Ogre::RenderTarget &target)

virtual ::CEGUI::TextureTarget *	createTextureTarget ()
	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::TextureTarget *	default_createTextureTarget ()

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 void	endRendering ()
	Perform any operations required to finalise rendering.

void	default_endRendering ()

virtual ::CEGUI::uint	getMaxTextureSize () const
	Return the pixel size of the maximum supported texture. More...

::CEGUI::uint	default_getMaxTextureSize () const

void	initialiseShaders ()

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)

void	throwIfNameExists (::CEGUI::String const &name) const

Public Member Functions inherited from CEGUI::OgreRenderer
void	setRenderingEnabled (const bool enabled)
	set whether CEGUI rendering will occur

bool	isRenderingEnabled () const
	return whether CEGUI rendering is enabled.

Texture &	createTexture (const String &name, Ogre::TexturePtr &tex, bool take_ownership=false)
	Create a CEGUI::Texture that wraps an existing Ogre texture. More...

void	setupRenderingBlendMode (const BlendMode mode, const bool force=false)
	set the render states for the specified BlendMode.

void	setFrameControlExecutionEnabled (const bool enabled)
	Controls whether rendering done by CEGUI will be wrapped with calls to Ogre::RenderSystem::_beginFrame and Ogre::RenderSystem::_endFrame. More...

bool	isFrameControlExecutionEnabled () const
	Returns whether rendering done by CEGUI will be wrapped with calls to Ogre::RenderSystem::_beginFrame and Ogre::RenderSystem::_endFrame. More...

void	initialiseRenderStateSettings ()
	Sets all the required render states needed for CEGUI rendering. More...

void	setDefaultRootRenderTarget (Ogre::RenderTarget &target)
	Sets the Ogre::RenderTarget that should be targetted by the default GUIContext. More...

bool	isUsingShaders () const
	Returns whether the OgreRenderer is currently set to use shaders when doing its rendering operations. More...

void	setUsingShaders (const bool use_shaders)
	Set whether the OgreRenderer shound use shaders when performing its rendering operations. More...

void	bindShaders ()
	Perform required operations to bind shaders (or unbind them) depending on whether shader based rendering is currently enabled. More...

void	updateShaderParams () const
	Updates the shader constant parameters (i.e. uniforms). More...

void	setWorldMatrix (const Ogre::Matrix4 &m)
	Set the current world matrix to the given matrix.

void	setViewMatrix (const Ogre::Matrix4 &m)
	Set the current view matrix to the given matrix.

void	setProjectionMatrix (const Ogre::Matrix4 &m)
	Set the current projection matrix to the given matrix.

const Ogre::Matrix4 &	getWorldMatrix () const
	return a const reference to the current world matrix.

const Ogre::Matrix4 &	getViewMatrix () const
	return a const reference to the current view matrix.

const Ogre::Matrix4 &	getProjectionMatrix () const
	return a const reference to the current projection matrix.

const Ogre::Matrix4 &	getWorldViewProjMatrix () const
	Return a const reference to the final transformation matrix that should be used when transforming geometry. More...

RenderTarget &	getDefaultRenderTarget ()
	Returns the default RenderTarget object. The default render target is is typically one that targets the entire screen (or rendering window). More...

GeometryBuffer &	createGeometryBuffer ()
	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...

Texture &	createTexture (const String &name)
	Create a 'null' Texture object. More...

Texture &	createTexture (const String &name, const String &filename, const String &resourceGroup)
	Create a Texture object using the given image file. More...

Texture &	createTexture (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...

Texture &	getTexture (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 Sizef &	getDisplaySize () const
	Return the size of the display or host window in pixels. More...

const Vector2f &	getDisplayDPI () const
	Return the resolution of the display or host window in dots per inch. More...

const String &	getIdentifierString () const
	Return identification string for the renderer module. More...

void	setRenderingEnabled (const bool enabled)
	set whether CEGUI rendering will occur

bool	isRenderingEnabled () const
	return whether CEGUI rendering is enabled.

Texture &	createTexture (const String &name, Ogre::TexturePtr &tex, bool take_ownership=false)
	Create a CEGUI::Texture that wraps an existing Ogre texture. More...

void	setupRenderingBlendMode (const BlendMode mode, const bool force=false)
	set the render states for the specified BlendMode.

void	setFrameControlExecutionEnabled (const bool enabled)
	Controls whether rendering done by CEGUI will be wrapped with calls to Ogre::RenderSystem::_beginFrame and Ogre::RenderSystem::_endFrame. More...

bool	isFrameControlExecutionEnabled () const
	Returns whether rendering done by CEGUI will be wrapped with calls to Ogre::RenderSystem::_beginFrame and Ogre::RenderSystem::_endFrame. More...

void	initialiseRenderStateSettings ()
	Sets all the required render states needed for CEGUI rendering. More...

void	setDefaultRootRenderTarget (Ogre::RenderTarget &target)
	Sets the Ogre::RenderTarget that should be targetted by the default GUIContext. More...

bool	isUsingShaders () const
	Returns whether the OgreRenderer is currently set to use shaders when doing its rendering operations. More...

void	setUsingShaders (const bool use_shaders)
	Set whether the OgreRenderer shound use shaders when performing its rendering operations. More...

void	bindShaders ()
	Perform required operations to bind shaders (or unbind them) depending on whether shader based rendering is currently enabled. More...

void	updateShaderParams () const
	Updates the shader constant parameters (i.e. uniforms). More...

void	setWorldMatrix (const Ogre::Matrix4 &m)
	Set the current world matrix to the given matrix.

void	setViewMatrix (const Ogre::Matrix4 &m)
	Set the current view matrix to the given matrix.

void	setProjectionMatrix (const Ogre::Matrix4 &m)
	Set the current projection matrix to the given matrix.

const Ogre::Matrix4 &	getWorldMatrix () const
	return a const reference to the current world matrix.

const Ogre::Matrix4 &	getViewMatrix () const
	return a const reference to the current view matrix.

const Ogre::Matrix4 &	getProjectionMatrix () const
	return a const reference to the current projection matrix.

const Ogre::Matrix4 &	getWorldViewProjMatrix () const
	Return a const reference to the final transformation matrix that should be used when transforming geometry. More...

RenderTarget &	getDefaultRenderTarget ()
	Returns the default RenderTarget object. The default render target is is typically one that targets the entire screen (or rendering window). More...

GeometryBuffer &	createGeometryBuffer ()
	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.

TextureTarget *	createTextureTarget ()
	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.

Texture &	createTexture (const String &name)
	Create a 'null' Texture object. More...

Texture &	createTexture (const String &name, const String &filename, const String &resourceGroup)
	Create a Texture object using the given image file. More...

Texture &	createTexture (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.

Texture &	getTexture (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	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.

void	setDisplaySize (const Sizef &sz)
	Set the size of the display or host window in pixels for this Renderer object. More...

const Sizef &	getDisplaySize () const
	Return the size of the display or host window in pixels. More...

const Vector2f &	getDisplayDPI () 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 String &	getIdentifierString () const
	Return identification string for the renderer module. 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::OgreRenderer
static OgreRenderer &	bootstrapSystem (const int abi=CEGUI_VERSION_ABI)
	Convenience function that creates all the Ogre specific objects and then initialises the CEGUI system with them. More...

static OgreRenderer &	bootstrapSystem (Ogre::RenderTarget &target, const int abi=CEGUI_VERSION_ABI)
	Convenience function that creates all the Ogre specific objects and then initialises the CEGUI system with them. More...

static void	destroySystem ()
	Convenience function to cleanup the CEGUI system and related objects that were created by calling the bootstrapSystem function. More...

static OgreRenderer &	create (const int abi=CEGUI_VERSION_ABI)
	Create an OgreRenderer object that uses the default Ogre rendering window as the default output surface. More...

static OgreRenderer &	create (Ogre::RenderTarget &target, const int abi=CEGUI_VERSION_ABI)
	Create an OgreRenderer object that uses the specified Ogre::RenderTarget as the default output surface.

static void	destroy (OgreRenderer &renderer)
	destory an OgreRenderer object.

static OgreResourceProvider &	createOgreResourceProvider ()
	function to create a CEGUI::OgreResourceProvider object

static void	destroyOgreResourceProvider (OgreResourceProvider &rp)
	function to destroy a CEGUI::OgreResourceProvider object

static OgreImageCodec &	createOgreImageCodec ()
	function to create a CEGUI::OgreImageCodec object.

static void	destroyOgreImageCodec (OgreImageCodec &ic)
	function to destroy a CEGUI::OgreImageCodec object.

static OgreRenderer &	bootstrapSystem (const int abi=CEGUI_VERSION_ABI)
	Convenience function that creates all the Ogre specific objects and then initialises the CEGUI system with them. More...

static OgreRenderer &	bootstrapSystem (Ogre::RenderTarget &target, const int abi=CEGUI_VERSION_ABI)
	Convenience function that creates all the Ogre specific objects and then initialises the CEGUI system with them. More...

static void	destroySystem ()
	Convenience function to cleanup the CEGUI system and related objects that were created by calling the bootstrapSystem function. More...

static OgreRenderer &	create (const int abi=CEGUI_VERSION_ABI)
	Create an OgreRenderer object that uses the default Ogre rendering window as the default output surface. More...

static OgreRenderer &	create (Ogre::RenderTarget &target, const int abi=CEGUI_VERSION_ABI)
	Create an OgreRenderer object that uses the specified Ogre::RenderTarget as the default output surface.

static void	destroy (OgreRenderer &renderer)
	destory an OgreRenderer object.

static OgreResourceProvider &	createOgreResourceProvider ()
	function to create a CEGUI::OgreResourceProvider object

static void	destroyOgreResourceProvider (OgreResourceProvider &rp)
	function to destroy a CEGUI::OgreResourceProvider object

static OgreImageCodec &	createOgreImageCodec ()
	function to create a CEGUI::OgreImageCodec object.

static void	destroyOgreImageCodec (OgreImageCodec &ic)
	function to destroy a CEGUI::OgreImageCodec object.

Additional Inherited Members
Protected Member Functions inherited from CEGUI::OgreRenderer
	OgreRenderer ()
	default constructor.

	OgreRenderer (Ogre::RenderTarget &target)
	constructor takin the Ogre::RenderTarget to use as the default root.

virtual	~OgreRenderer ()
	destructor.

void	checkOgreInitialised ()
	checks Ogre initialisation. throws exceptions if an issue is detected.

void	throwIfNameExists (const String &name) const
	helper to throw exception if name is already used.

void	constructor_impl (Ogre::RenderTarget &target)
	common parts of constructor

void	initialiseShaders ()
	helper that creates and sets up shaders

void	cleanupShaders ()
	helper to clean up shaders

	OgreRenderer ()
	default constructor.

	OgreRenderer (Ogre::RenderTarget &target)
	constructor takin the Ogre::RenderTarget to use as the default root.

virtual	~OgreRenderer ()
	destructor.

void	checkOgreInitialised ()
	checks Ogre initialisation. throws exceptions if an issue is detected.

void	throwIfNameExists (const String &name) const
	helper to throw exception if name is already used.

void	constructor_impl (Ogre::RenderTarget &target)
	common parts of constructor

void	initialiseShaders ()
	helper that creates and sets up shaders

void	cleanupShaders ()
	helper to clean up shaders

Static Protected Member Functions inherited from CEGUI::OgreRenderer
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::OgreRenderer
OgreRenderer_impl *	d_pimpl
	Pointer to the hidden implementation data.

Member Function Documentation

virtual ::CEGUI::TextureTarget* OgreRenderer_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::OgreRenderer.

References CEGUI::OgreRenderer::createTextureTarget().

virtual ::CEGUI::uint OgreRenderer_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::OgreRenderer.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation