Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that are implemented using textures. More...

Inherits CEGUI::RenderTarget.

Inherited by CEGUI::Direct3D10RenderTarget< TextureTarget >, CEGUI::Direct3D11RenderTarget< TextureTarget >, CEGUI::Direct3D9RenderTarget< TextureTarget >, CEGUI::IrrlichtRenderTarget< TextureTarget >, CEGUI::NullRenderTarget< TextureTarget >, CEGUI::OgreRenderTarget< TextureTarget >, CEGUI::OpenGLESRenderTarget< TextureTarget >, and CEGUI::OpenGLRenderTarget< TextureTarget >.

Collaboration diagram for CEGUI::TextureTarget:

Public Member Functions
virtual void	clear ()=0
	Clear the surface of the underlying texture.

virtual Texture &	getTexture () const =0
	Return a pointer to the CEGUI::Texture that the TextureTarget is using. More...

virtual void	declareRenderSize (const Sizef &sz)=0
	Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations. More...

virtual bool	isRenderingInverted () const =0
	Return whether rendering done on the target texture is inverted in relation to regular textures. More...

Public Member Functions inherited from CEGUI::RenderTarget
virtual void	draw (const GeometryBuffer &buffer)=0
	Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents. More...

virtual void	draw (const RenderQueue &queue)=0
	Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents. More...

virtual void	setArea (const Rectf &area)=0
	Set the area for this RenderTarget. The exact action this function will take depends upon what the concrete class is representing. For example, with a 'view port' style RenderTarget, this should set the area that the view port occupies on the display (or rendering window). More...

virtual const Rectf &	getArea () const =0
	Return the area defined for this RenderTarget. More...

virtual bool	isImageryCache () const =0
	Return whether the RenderTarget is an implementation that caches actual rendered imagery. More...

virtual void	activate ()=0
	Activate the render target and put it in a state ready to be drawn to. More...

virtual void	deactivate ()=0
	Deactivate the render target after having completed rendering. More...

virtual void	unprojectPoint (const GeometryBuffer &buff, const Vector2f &p_in, Vector2f &p_out) const =0
	Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer buff.

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

virtual	~EventSet (void)
	Destructor for EventSet objects.

void	addEvent (const String &name)
	Creates a new Event object with the given name and adds it to the EventSet. More...

void	addEvent (Event &event)
	Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...

void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...

void	removeEvent (Event &event)
	Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...

void	removeAllEvents (void)
	Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.

bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in this 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...

template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...

template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2)
	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	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...

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

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

Additional Inherited Members
Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator < EventMap >	EventIterator

Static Public Attributes inherited from CEGUI::RenderTarget
static const String	EventNamespace
	Namespace for global events.

static const String	EventAreaChanged

Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event , StringFastLessCompare CEGUI_MAP_ALLOC(String, Event )>	EventMap

Protected Member Functions inherited from CEGUI::EventSet
void	fireEvent_impl (const String &name, EventArgs &args)
	Implementation event firing member.

ScriptModule *	getScriptModule () const
	Helper to return the script module pointer or throw.

	EventSet (EventSet &)

EventSet &	operator= (EventSet &)

Protected Attributes inherited from CEGUI::EventSet
EventMap	d_events

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

Detailed Description

Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that are implemented using textures.

Member Function Documentation

virtual void CEGUI::TextureTarget::declareRenderSize ( const Sizef & sz )

pure virtual

Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations.

Note: The main purpose of this is to allow for the implemenatation to resize the underlying texture so that it can hold the imagery that will be drawn.

Parameters

sz	Size object describing the largest area that will be rendererd in the next batch of rendering operations.

Exceptions

InvalidRequestException May be thrown if the TextureTarget would not be able to handle the operations rendering content of the given size.

Implemented in CEGUI::Direct3D9TextureTarget, CEGUI::Direct3D10TextureTarget, CEGUI::Direct3D11TextureTarget, CEGUI::IrrlichtTextureTarget, CEGUI::OpenGLWGLPBTextureTarget, CEGUI::OpenGLESFBOTextureTarget, CEGUI::OpenGL3FBOTextureTarget, CEGUI::OpenGLFBOTextureTarget, CEGUI::NullTextureTarget, CEGUI::OgreTextureTarget, CEGUI::OpenGLGLXPBTextureTarget, and CEGUI::OpenGLApplePBTextureTarget.

virtual Texture& CEGUI::TextureTarget::getTexture ( ) const

pure virtual

Return a pointer to the CEGUI::Texture that the TextureTarget is using.

Returns: Texture object that the TextureTarget uses when rendering imagery.

Implemented in CEGUI::Direct3D9TextureTarget, CEGUI::Direct3D10TextureTarget, CEGUI::Direct3D11TextureTarget, CEGUI::IrrlichtTextureTarget, CEGUI::OpenGLESFBOTextureTarget, CEGUI::OpenGLTextureTarget, CEGUI::NullTextureTarget, and CEGUI::OgreTextureTarget.

virtual bool CEGUI::TextureTarget::isRenderingInverted ( ) const

pure virtual

Return whether rendering done on the target texture is inverted in relation to regular textures.

This is intended to be used when generating geometry for rendering the
TextureTarget onto another surface.

Returns

true if the texture content should be considered as inverted vertically in comparison with other regular textures.
false if the texture content has the same orientation as regular textures.

Implemented in CEGUI::Direct3D9TextureTarget, CEGUI::Direct3D10TextureTarget, CEGUI::Direct3D11TextureTarget, CEGUI::IrrlichtTextureTarget, CEGUI::OpenGLESFBOTextureTarget, CEGUI::OpenGLTextureTarget, CEGUI::NullTextureTarget, and CEGUI::OgreTextureTarget.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation