Crazy Eddie's GUI System  0.8.7
RenderEffect.h
1 /***********************************************************************
2  created: Sat Jan 17 2009
3  author: Paul D Turner
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining
9  * a copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sublicense, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be
17  * included in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  ***************************************************************************/
27 #ifndef _CEGUIRenderEffect_h_
28 #define _CEGUIRenderEffect_h_
29 
30 #include "CEGUI/Base.h"
31 
32 // Start of CEGUI namespace section
33 namespace CEGUI
34 {
40 class CEGUIEXPORT RenderEffect :
41  public AllocatedObject<RenderEffect>
42 {
43 public:
44  virtual ~RenderEffect() {};
53  virtual int getPassCount() const = 0;
54 
68  virtual void performPreRenderFunctions(const int pass) = 0;
69 
80  virtual void performPostRenderFunctions() = 0;
81 
104  virtual bool realiseGeometry(RenderingWindow& window,
105  GeometryBuffer& geometry) = 0;
106 
128  virtual bool update(const float elapsed, RenderingWindow& window) = 0;
129 };
130 
131 } // End of CEGUI namespace section
132 
133 #endif // end of guard _CEGUIRenderEffect_h_
CEGUI::GeometryBuffer
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:44
CEGUI::RenderEffect::performPostRenderFunctions
virtual void performPostRenderFunctions()=0
Function called after RenderingWindow::draw is called. This is intended to be used for any required c...
CEGUI::RenderEffect::update
virtual bool update(const float elapsed, RenderingWindow &window)=0
Function called to perform any time based updates on the RenderEffect state.
CEGUI
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
CEGUI::AllocatedObject
Definition: MemoryAllocatedObject.h:110
CEGUI::RenderEffect::getPassCount
virtual int getPassCount() const =0
Return the number of passes required by this effect.
CEGUI::RenderingWindow
RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...
Definition: RenderingWindow.h:51
CEGUI::RenderEffect::realiseGeometry
virtual bool realiseGeometry(RenderingWindow &window, GeometryBuffer &geometry)=0
Function called to generate geometry for the RenderingWindow.
CEGUI::RenderEffect::performPreRenderFunctions
virtual void performPreRenderFunctions(const int pass)=0
Function called prior to RenderingWindow::draw being called. This is intended to be used for any requ...
CEGUI::RenderEffect
Interface for objects that hook into RenderingWindow to affect the rendering process,...
Definition: RenderEffect.h:42