Crazy Eddie's GUI System 0.8.7
Loading...
Searching...
No Matches
CEGUI::Direct3D11RenderTarget< T > Class Template Reference

Implementation of an ntermediate RenderTarget for the Direct3D 10 API. More...

#include <RenderTarget.h>

+ Inheritance diagram for CEGUI::Direct3D11RenderTarget< T >:

Public Member Functions

 Direct3D11RenderTarget (Direct3D11Renderer &owner)
 Constructor.
 
void draw (const GeometryBuffer &buffer)
 Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents.
 
void draw (const RenderQueue &queue)
 Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents.
 
void setArea (const Rectf &area)
 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).
 
const RectfgetArea () const
 Return the area defined for this RenderTarget.
 
void activate ()
 Activate the render target and put it in a state ready to be drawn to.
 
void deactivate ()
 Deactivate the render target after having completed rendering.
 
void unprojectPoint (const GeometryBuffer &buff, const Vector2f &p_in, Vector2f &p_out) const
 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::RenderTarget
virtual bool isImageryCache () const =0
 Return whether the RenderTarget is an implementation that caches actual rendered imagery.
 
- 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.
 
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.
 
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.
 
void removeEvent (Event &event)
 Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed.
 
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.
 
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.
 
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.
 
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.
 
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.
 
virtual Event::Connection subscribeScriptedEvent (const String &name, const String &subscriber_name)
 Subscribes the named Event to a scripted funtion.
 
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.
 
virtual void fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
 Fires the named event passing the given EventArgs object.
 
bool isMuted (void) const
 Return whether the EventSet is muted or not.
 
void setMutedState (bool setting)
 Set the mute state for this EventSet.
 
EventgetEventObject (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.
 
EventIterator getEventIterator (void) const
 Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.
 
- Public Member Functions inherited from CEGUI::AllocatedObject< RenderTarget >

Protected Member Functions

void updateMatrix () const
 helper that initialises the cached matrix
 
void setupViewport (D3D11_VIEWPORT &vp) const
 helper to initialise the D3D10_VIEWPORT vp for this target.
 
- Protected Member Functions inherited from CEGUI::EventSet
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
 EventSet (const EventSet &)
 
EventSetoperator= (EventSet &)
 
EventSetoperator= (const EventSet &)
 

Protected Attributes

Direct3D11Rendererd_owner
 Renderer that created and owns the render target.
 
IDevice11d_device
 D3D10Device interface.
 
Rectf d_area
 holds defined area for the RenderTarget
 
D3DXMATRIX d_matrix
 projection / view matrix cache
 
bool d_matrixValid
 true when d_matrix is valid and up to date
 
float d_viewDistance
 tracks viewing distance (this is set up at the same time as d_matrix)
 
- 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 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
 

Detailed Description

template<typename T = RenderTarget>
class CEGUI::Direct3D11RenderTarget< T >

Implementation of an ntermediate RenderTarget for the Direct3D 10 API.

Member Function Documentation

◆ activate()

template<typename T = RenderTarget>
void CEGUI::Direct3D11RenderTarget< T >::activate ( )
virtual

Activate the render target and put it in a state ready to be drawn to.

Note
You MUST call this before doing any rendering - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version.

Implements CEGUI::RenderTarget.

Reimplemented in CEGUI::Direct3D11TextureTarget.

◆ deactivate()

template<typename T = RenderTarget>
void CEGUI::Direct3D11RenderTarget< T >::deactivate ( )
virtual

Deactivate the render target after having completed rendering.

Note
You MUST call this after you finish rendering to the target - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version.

Implements CEGUI::RenderTarget.

Reimplemented in CEGUI::Direct3D11TextureTarget.

◆ draw() [1/2]

template<typename T = RenderTarget>
void CEGUI::Direct3D11RenderTarget< T >::draw ( const GeometryBuffer & buffer)
virtual

Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents.

Parameters
bufferGeometryBuffer object holding the geometry that should be drawn to the RenderTarget.

Implements CEGUI::RenderTarget.

◆ draw() [2/2]

template<typename T = RenderTarget>
void CEGUI::Direct3D11RenderTarget< T >::draw ( const RenderQueue & queue)
virtual

Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents.

Parameters
queueRenderQueue object holding the geometry that should be drawn to the RenderTarget.

Implements CEGUI::RenderTarget.

◆ getArea()

template<typename T = RenderTarget>
const Rectf & CEGUI::Direct3D11RenderTarget< T >::getArea ( ) const
virtual

Return the area defined for this RenderTarget.

Returns
Rect object describing the currently defined area for this RenderTarget.

Implements CEGUI::RenderTarget.

◆ setArea()

template<typename T = RenderTarget>
void CEGUI::Direct3D11RenderTarget< T >::setArea ( const Rectf & area)
virtual

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

Parameters
areaRect object describing the new area to be assigned to the RenderTarget.
Note
When implementing this function, you should be sure to fire the event RenderTarget::EventAreaChanged so that interested parties can know that the change has occurred.
Exceptions
InvalidRequestExceptionMay be thrown if the RenderTarget does not support setting or changing its area, or if the area change can not be satisfied for some reason.

Implements CEGUI::RenderTarget.

◆ unprojectPoint()

template<typename T = RenderTarget>
void CEGUI::Direct3D11RenderTarget< T >::unprojectPoint ( const GeometryBuffer & buff,
const Vector2f & p_in,
Vector2f & p_out ) const
virtual

Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer buff.

Implements CEGUI::RenderTarget.