Abstract class defining the interface for Renderer objects. More...

Inheritance diagram for CEGUI::Renderer:

Collaboration diagram for CEGUI::Renderer:

Public Member Functions
virtual void	addQuad (const Rect &dest_rect, float z, const Texture *tex, const Rect &texture_rect, const ColourRect &colours, QuadSplitMode quad_split_mode)=0
	Add a quad to the rendering queue. All clipping and other adjustments should have been made prior to calling this. More...

virtual void	doRender (void)=0
	Perform final rendering for all quads that have been queued for rendering. More...

virtual void	clearRenderList (void)=0
	Clears all queued quads from the render queue. More...

virtual void	setQueueingEnabled (bool setting)=0
	Enable or disable the queueing of quads from this point on. More...

virtual Texture *	createTexture (void)=0
	Creates a 'null' Texture object. More...

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

virtual Texture *	createTexture (float size)=0
	Create a Texture object with the given pixel dimensions as specified by size. NB: Textures are always square. More...

virtual void	destroyTexture (Texture *texture)=0
	Destroy the given Texture object. More...

virtual void	destroyAllTextures (void)=0
	Destroy all Texture objects. More...

virtual bool	isQueueingEnabled (void) const =0
	Return whether queueing is enabled. More...

virtual float	getWidth (void) const =0
	Return the current width of the display in pixels. More...

virtual float	getHeight (void) const =0
	Return the current height of the display in pixels. More...

virtual Size	getSize (void) const =0
	Return the size of the display in pixels. More...

virtual Rect	getRect (void) const =0
	Return a Rect describing the screen. More...

virtual uint	getMaxTextureSize (void) const =0
	Return the maximum texture size available. More...

virtual uint	getHorzScreenDPI (void) const =0
	Return the horizontal display resolution dpi. More...

virtual uint	getVertScreenDPI (void) const =0
	Return the vertical display resolution dpi. More...

void	resetZValue (void)
	Reset the z co-ordinate for rendering. More...

void	advanceZValue (void)
	Update the z co-ordinate for the next major UI element (window). More...

float	getCurrentZ (void) const
	return the current Z value to use (equates to layer 0 for this UI element). More...

float	getZLayer (uint layer) const
	return the z co-ordinate to use for the requested layer on the current GUI element. More...

const String &	getIdentifierString () const
	Return identification string for the renderer module. If the internal id string has not been set by the Renderer module creator, a generic string of "Unknown renderer" will be returned. More...

virtual ResourceProvider *	createResourceProvider (void)

Public Member Functions inherited from CEGUI::EventSet
	EventSet ()
	Constructor for EventSet objects.

virtual	~EventSet (void)
	Destructor for EventSet objects.

void	addEvent (const String &name)
	Add a new Event to the EventSet with the given name. More...

void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected. More...

void	removeAllEvents (void)
	Remove all Event objects from the EventSet. More...

bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in the EventSet. More...

virtual Event::Connection	subscribeEvent (const String &name, Event::Subscriber subscriber)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...

virtual Event::Connection	subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
	Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...

virtual Event::Connection	subscribeScriptedEvent (const String &name, const String &subscriber_name)
	Subscribes the named Event to a scripted funtion. More...

virtual Event::Connection	subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
	Subscribes the specified group of the named Event to a scripted funtion. More...

virtual void	fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
	Fires the named event passing the given EventArgs object. More...

bool	isMuted (void) const
	Return whether the EventSet is muted or not. More...

void	setMutedState (bool setting)
	Set the mute state for this EventSet. More...

Iterator	getIterator (void) const
	Return a EventSet::Iterator object to iterate over the events currently added to the EventSet.

Static Public Attributes
static const String	EventNamespace
	Namespace for global events.

static const String	EventDisplaySizeChanged

Protected Attributes
ResourceProvider *	d_resourceProvider
	Holds the pointer to the ResourceProvider object.

String	d_identifierString
	String that holds some id information about the renderer.

Protected Attributes inherited from CEGUI::EventSet
EventMap	d_events

bool	d_muted
	true if events for this EventSet have been muted.

Additional Inherited Members
Public Types inherited from CEGUI::EventSet
typedef ConstBaseIterator < EventMap >	Iterator

Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event *, String::FastLessCompare >	EventMap

Protected Member Functions inherited from CEGUI::EventSet
Event *	getEventObject (const String &name, bool autoAdd=false)
	Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...

void	fireEvent_impl (const String &name, EventArgs &args)
	Implementation event firing member.

	EventSet (EventSet &e)

EventSet &	operator= (EventSet &e)

Detailed Description

Abstract class defining the interface for Renderer objects.

Objects derived from Renderer are the means by which the GUI system interfaces with specific rendering technologies. To use a rendering system or API to draw CEGUI imagery requires that an appropriate Renderer object be available.

Member Function Documentation

virtual void CEGUI::Renderer::addQuad	(	const Rect &	dest_rect,
		float	z,
		const Texture *	tex,
		const Rect &	texture_rect,
		const ColourRect &	colours,
		QuadSplitMode	quad_split_mode
	)

pure virtual

Add a quad to the rendering queue. All clipping and other adjustments should have been made prior to calling this.

Parameters

dest_rect	Rect object describing the destination area (values are in pixels)
z	float value specifying the z co-ordinate / z order of the quad
tex	pointer to the Texture object that holds the imagery to be rendered
texture_rect	Rect object holding the area of tex that is to be rendered (values are in texture co-ordinates).
colours	ColourRect object describing the colour values that are to be applied when rendering.
quad_split_mode	One of the QuadSplitMode values specifying the way quads are split into triangles

Returns: Nothing

Referenced by CEGUI::Imageset::draw().

void CEGUI::Renderer::advanceZValue ( void )

inline

Update the z co-ordinate for the next major UI element (window).

Returns: Nothing

Referenced by CEGUI::Window::render().

virtual void CEGUI::Renderer::clearRenderList ( void )

pure virtual

Clears all queued quads from the render queue.

Returns: Nothing

Referenced by CEGUI::System::renderGUI().

virtual Texture* CEGUI::Renderer::createTexture ( void )

pure virtual

Creates a 'null' Texture object.

Returns: a newly created Texture object. The returned Texture object has no size or imagery associated with it, and is generally of little or no use.

Referenced by CEGUI::FreeTypeFont::rasterize().

virtual Texture* CEGUI::Renderer::createTexture	(	const String &	filename,
		const String &	resourceGroup
	)

pure virtual

Create a Texture object using the given image file.

Parameters

filename	String object that specifies the path and filename of the image file to use when creating the texture.
resourceGroup	Resource group identifier to be passed to the resource provider when loading the texture file.

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

Note: Textures are always created with a size that is a power of 2. If the file you specify is of a size that is not a power of two, the final size will be rounded up. Additionally, textures are always square, so the ultimate size is governed by the larger of the width and height of the specified file. You can check the ultimate sizes by querying the texture after creation.

virtual Texture* CEGUI::Renderer::createTexture ( float size )

pure virtual

Create a Texture object with the given pixel dimensions as specified by size. NB: Textures are always square.

Parameters

size	float value that specifies the size to use for the width and height when creating the new texture.

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

Note: Textures are always created with a size that is a power of 2. If you specify a size that is not a power of two, the final size will be rounded up. So if you specify a size of 1024, the texture will be (1024 x 1024), however, if you specify a size of 1025, the texture will be (2048 x 2048). You can check the ultimate size by querying the texture after creation.

virtual void CEGUI::Renderer::destroyAllTextures ( void )

pure virtual

Destroy all Texture objects.

Returns: Nothing

virtual void CEGUI::Renderer::destroyTexture ( Texture * texture )

pure virtual

Destroy the given Texture object.

Parameters

texture pointer to the Texture object to be destroyed

Returns: Nothing

Referenced by CEGUI::Imageset::unload().

virtual void CEGUI::Renderer::doRender ( void )

pure virtual

Perform final rendering for all quads that have been queued for rendering.

    The contents of the rendering queue is retained and can be rendered again as required.  If the contents is not required call clearRenderList().

Returns: Nothing

Referenced by CEGUI::System::renderGUI().

float CEGUI::Renderer::getCurrentZ ( void ) const

inline

return the current Z value to use (equates to layer 0 for this UI element).

Returns: float value that specifies the z co-ordinate to be used for layer 0 on the current GUI element.

Referenced by CEGUI::Tree::populateRenderCache(), and CEGUI::Window::render().

virtual float CEGUI::Renderer::getHeight ( void ) const

pure virtual

Return the current height of the display in pixels.

Returns: float value equal to the current height of the display in pixels.

Referenced by CEGUI::Window::getParentPixelHeight(), CEGUI::FrameWindow::moveBottomEdge(), and CEGUI::FrameWindow::moveTopEdge().

virtual uint CEGUI::Renderer::getHorzScreenDPI ( void ) const

pure virtual

Return the horizontal display resolution dpi.

Returns: horizontal resolution of the display in dpi.

Referenced by CEGUI::FreeTypeFont::updateFont().

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

Return identification string for the renderer module. If the internal id string has not been set by the Renderer module creator, a generic string of "Unknown renderer" will be returned.

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

References d_identifierString.

virtual uint CEGUI::Renderer::getMaxTextureSize ( void ) const

pure virtual

Return the maximum texture size available.

Returns: Size of the maximum supported texture in pixels (textures are always assumed to be square)

Referenced by CEGUI::FreeTypeFont::getTextureSize().

virtual Rect CEGUI::Renderer::getRect ( void ) const

pure virtual

Return a Rect describing the screen.

Returns: A Rect object that describes the screen area. Typically, the top-left values are always 0, and the size of the area described is equal to the screen resolution.

Referenced by CEGUI::ScrolledContainer::getUnclippedInnerRect_impl(), CEGUI::Titlebar::onMouseButtonDown(), CEGUI::MouseCursor::setConstraintArea(), and CEGUI::MouseCursor::setUnifiedConstraintArea().

virtual Size CEGUI::Renderer::getSize ( void ) const

pure virtual

Return the size of the display in pixels.

Returns: Size object describing the dimensions of the current display.

Referenced by CEGUI::Font::Font(), CEGUI::MouseCursor::getConstraintArea(), CEGUI::CoordConverter::screenToWindow(), and CEGUI::Window::setArea_impl().

virtual uint CEGUI::Renderer::getVertScreenDPI ( void ) const

pure virtual

Return the vertical display resolution dpi.

Returns: vertical resolution of the display in dpi.

Referenced by CEGUI::FreeTypeFont::updateFont().

virtual float CEGUI::Renderer::getWidth ( void ) const

pure virtual

Return the current width of the display in pixels.

Returns: float value equal to the current width of the display in pixels.

Referenced by CEGUI::ListHeaderSegment::doDragSizing(), CEGUI::Window::getParentPixelWidth(), CEGUI::FrameWindow::moveLeftEdge(), and CEGUI::FrameWindow::moveRightEdge().

float CEGUI::Renderer::getZLayer ( uint layer ) const

inline

return the z co-ordinate to use for the requested layer on the current GUI element.

Parameters

layer Specifies the layer to return the Z co-ordinate for. Each GUI element can use up to 10 layers, so valid inputs are 0 to 9 inclusive. If you specify an invalid value for layer, results are undefined.

Returns: float value that specifies the Z co-ordinate for layer layer on the current GUI element.

Referenced by CEGUI::Tree::populateRenderCache().

virtual bool CEGUI::Renderer::isQueueingEnabled ( void ) const

pure virtual

Return whether queueing is enabled.

Returns: true if queueing is enabled, false if queueing is disabled.

void CEGUI::Renderer::resetZValue ( void )

inline

Reset the z co-ordinate for rendering.

Returns: Nothing

Referenced by CEGUI::System::renderGUI().

virtual void CEGUI::Renderer::setQueueingEnabled ( bool setting )

pure virtual

Enable or disable the queueing of quads from this point on.

    This only affects queueing.  If queueing is turned off, any calls to addQuad will cause the quad to be rendered directly.  Note that
    disabling queueing will not cause currently queued quads to be rendered, nor is the queue cleared - at any time the queue can still
    be drawn by calling doRender, and the list can be cleared by calling clearRenderList.  Re-enabling the queue causes subsequent quads
    to be added as if queueing had never been disabled.

Parameters

setting true to enable queueing, or false to disable queueing (see notes above).

Returns: Nothing

Referenced by CEGUI::System::renderGUI().

Member Data Documentation

const String CEGUI::Renderer::EventDisplaySizeChanged

static

event that fires when the underlying display size had changed.

It is important that all Renderer implementers fire this properly as the system itself subscribes to this event.

Referenced by CEGUI::System::System().

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation