CEGUI::Renderer implementation for the Irrlicht engine. More...

Inheritance diagram for CEGUI::IrrlichtRenderer:

Collaboration diagram for CEGUI::IrrlichtRenderer:

Public Member Functions
bool	injectEvent (const irr::SEvent &event)
	inject irrlicht event to CEGUI system

Sizef	getAdjustedTextureSize (const Sizef &sz) const
	Helper to return a valid texture size according to device capabilities. 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...

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...

const IrrlichtEventPusher *	getEventPusher () const

Public Member Functions inherited from CEGUI::Renderer
virtual	~Renderer ()
	Destructor.

Static Public Member Functions
static IrrlichtRenderer &	bootstrapSystem (irr::IrrlichtDevice &device, const int abi=CEGUI_VERSION_ABI)
	Convenience function that creates all the Irrlicht 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 IrrlichtRenderer &	create (irr::IrrlichtDevice &device, const int abi=CEGUI_VERSION_ABI)
	Function to create and return IrrlichtRenderer objects.

static void	destroy (IrrlichtRenderer &renderer)
	Function to destroy IrrlichtRenderer objects.

static IrrlichtResourceProvider &	createIrrlichtResourceProvider (irr::io::IFileSystem &fs)
	Create a IrrlichtResourceProvider object.

static void	destroyIrrlichtResourceProvider (IrrlichtResourceProvider &rp)
	Destroy a IrrlichtResourceProvider object.

static IrrlichtImageCodec &	createIrrlichtImageCodec (irr::video::IVideoDriver &driver)
	function to create a CEGUI::IrrlichtImageCodec object.

static void	destroyIrrlichtImageCodec (IrrlichtImageCodec &ic)
	function to destroy a CEGUI::IrrlichtImageCodec object.

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.

Protected Types
typedef std::vector< TextureTarget * >	TextureTargetList
	container type used to hold TextureTargets we create.

typedef std::vector< IrrlichtGeometryBuffer * >	GeometryBufferList
	container type used to hold GeometryBuffers we create.

typedef std::map< String, IrrlichtTexture , StringFastLessCompare CEGUI_MAP_ALLOC(String, IrrlichtTexture )>	TextureMap
	container type used to hold Textures we create.

Protected Member Functions
	IrrlichtRenderer (irr::IrrlichtDevice &device)
	Constructor.

	~IrrlichtRenderer ()
	Destructor.

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

Static Protected Member Functions
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
irr::IrrlichtDevice &	d_device
	The IrrlichtDevide that we'll be using.

irr::video::IVideoDriver *	d_driver
	Irrlicht video driver (as obtained from the device)

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.

RenderTarget *	d_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.

IrrlichtEventPusher *	d_eventPusher
	ptr to helper object that aids in injection of events from Irrlicht.

bool	d_supportsNSquareTextures
	true if driver supports non square textures

bool	d_supportsNPOTTextures
	true if driver supports non power of two textures

Static Protected Attributes
static String	d_rendererID
	String holding the renderer identification text.

Detailed Description

CEGUI::Renderer implementation for the Irrlicht engine.

Member Function Documentation

static IrrlichtRenderer& CEGUI::IrrlichtRenderer::bootstrapSystem	(	irr::IrrlichtDevice &	device,
		const int	abi = `CEGUI_VERSION_ABI`
	)

static

Convenience function that creates all the Irrlicht specific objects and then initialises the CEGUI system with them.

This will create and initialise the following objects for you:

Parameters

device	Reference to the irr::IrrlichtDevice to be used when creating the CEGUI::IrrlichtRenderer object.
abi	This must be set to CEGUI_VERSION_ABI

Returns: A reference to the CEGUI::IrrlichtRenderer object that was created.

GeometryBuffer& CEGUI::IrrlichtRenderer::createGeometryBuffer ( )

virtual

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.

Returns: GeometryBuffer object.

Implements CEGUI::Renderer.

Texture& CEGUI::IrrlichtRenderer::createTexture ( const String & name )

virtual

Create a 'null' Texture object.

Parameters

name	String holding the name for the new texture. Texture names must be unique within the Renderer.

Returns: A newly created Texture object. The returned Texture object has no size or imagery associated with it.

AlreadyExistsException - thrown if a Texture object named name already exists within the system.

Implements CEGUI::Renderer.

Texture& CEGUI::IrrlichtRenderer::createTexture	(	const String &	name,
		const String &	filename,
		const String &	resourceGroup
	)

virtual

Create a Texture object using the given image file.

Parameters

name	String holding the name for the new texture. Texture names must be unique within the Renderer.
filename	String object that specifies the path and filename of the image file to use when creating the texture.
resourceGroup	String objet that specifies the resource group identifier to be passed to the resource provider when loading the texture file filename.

Returns: A newly created Texture object. The initial content of the texture memory is the requested image file.

Note: Due to possible limitations of the underlying hardware, API or engine, the final size of the texture may not match the size of the loaded file. You can check the ultimate sizes by querying the Texture object after creation.

AlreadyExistsException - thrown if a Texture object named name already exists within the system.

Implements CEGUI::Renderer.

Texture& CEGUI::IrrlichtRenderer::createTexture	(	const String &	name,
		const Sizef &	size
	)

virtual

Create a Texture object with the given pixel dimensions as specified by size.

Parameters

name	String holding the name for the new texture. Texture names must be unique within the Renderer.
size	Size object that describes the desired texture size.

Returns: A newly created Texture object. The initial contents of the texture memory is undefined.

Note: Due to possible limitations of the underlying hardware, API or engine, the final size of the texture may not match the requested size. You can check the ultimate sizes by querying the Texture object after creation.

AlreadyExistsException - thrown if a Texture object named name already exists within the system.

Implements CEGUI::Renderer.

TextureTarget* CEGUI::IrrlichtRenderer::createTextureTarget ( )

virtual

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.

Implements CEGUI::Renderer.

void CEGUI::IrrlichtRenderer::destroyGeometryBuffer ( const GeometryBuffer & buffer )

virtual

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.

Parameters

buffer The GeometryBuffer object to be destroyed.

Implements CEGUI::Renderer.

static void CEGUI::IrrlichtRenderer::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.

void CEGUI::IrrlichtRenderer::destroyTexture ( Texture & texture )

virtual

Destroy a Texture object that was previously created by calling the createTexture functions.

Parameters

texture Texture object to be destroyed.

Implements CEGUI::Renderer.

void CEGUI::IrrlichtRenderer::destroyTexture ( const String & name )

virtual

Destroy a Texture object that was previously created by calling the createTexture functions.

Parameters

name	String holding the name of the texture to destroy.

Implements CEGUI::Renderer.

void CEGUI::IrrlichtRenderer::destroyTextureTarget ( TextureTarget * target )

virtual

Function that cleans up TextureTarget objects created with the createTextureTarget function.

Parameters

target A pointer to a TextureTarget object that was previously returned from a call to createTextureTarget.

Implements CEGUI::Renderer.

Sizef CEGUI::IrrlichtRenderer::getAdjustedTextureSize ( const Sizef & sz ) const

Helper to return a valid texture size according to device capabilities.

Parameters

sz	Size object containing input size.

Returns: Size object containing - possibly different - output size.

RenderTarget& CEGUI::IrrlichtRenderer::getDefaultRenderTarget ( )

virtual

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

Returns: Reference to a RenderTarget object.

Implements CEGUI::Renderer.

const Vector2f& CEGUI::IrrlichtRenderer::getDisplayDPI ( ) const

virtual

Return the resolution of the display or host window in dots per inch.

Returns: Vector2 object that describes the resolution of the display or host window in DPI.

Implements CEGUI::Renderer.

const Sizef& CEGUI::IrrlichtRenderer::getDisplaySize ( ) const

virtual

Return the size of the display or host window in pixels.

Returns: Size object describing the pixel dimesntions of the current display or host window.

Implements CEGUI::Renderer.

const String& CEGUI::IrrlichtRenderer::getIdentifierString ( ) const

virtual

Return identification string for the renderer module.

Returns: String object holding text that identifies the Renderer in use.

Implements CEGUI::Renderer.

uint CEGUI::IrrlichtRenderer::getMaxTextureSize ( ) const

virtual

Return the pixel size of the maximum supported texture.

Returns: Size of the maximum supported texture in pixels.

Implements CEGUI::Renderer.

Texture& CEGUI::IrrlichtRenderer::getTexture ( const String & name ) const

virtual

Return a Texture object that was previously created by calling the createTexture functions.

Parameters

name	String holding the name of the Texture object to be returned.

UnknownObjectException - thrown if no Texture object named name exists within the system.

Implements CEGUI::Renderer.

bool CEGUI::IrrlichtRenderer::isTexCoordSystemFlipped ( ) const

inline

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.

This function is intended to be used when generating geometry for rendering the TextureTarget onto another surface. It is also intended to be used when trying to use a custom texture (RTT) inside CEGUI using the Image class, in order to determine the Image coordinates correctly.

Returns

true if flipping is required: the texture coordinate origin is at the bottom left
false if flipping is not required: the texture coordinate origin is at the top left

void CEGUI::IrrlichtRenderer::setDisplaySize ( const Sizef & size )

virtual

Set the size of the display or host window in pixels for this Renderer object.

This is intended to be called by the System as part of the notification process when display size changes are notified to it via the System::notifyDisplaySizeChanged function.

Note: The Renderer implementation should not use this function other than to perform internal state updates on the Renderer and related objects.

Parameters

size	Size object describing the dimesions of the current or host window in pixels.

Implements CEGUI::Renderer.

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation