/usr/include/cegui-0.8.4/CEGUI/RenderEffect.h is in libcegui-mk2-dev 0.8.4+dfsg-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | /***********************************************************************
created: Sat Jan 17 2009
author: Paul D Turner
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIRenderEffect_h_
#define _CEGUIRenderEffect_h_
#include "CEGUI/Base.h"
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Interface for objects that hook into RenderingWindow to affect the rendering
process, thus allowing various effects to be achieved.
*/
class CEGUIEXPORT RenderEffect :
public AllocatedObject<RenderEffect>
{
public:
virtual ~RenderEffect() {};
/*!
\brief
Return the number of passes required by this effect.
\return
integer value indicating the number of rendering passes required to
fully render this effect.
*/
virtual int getPassCount() const = 0;
/*!
\brief
Function called prior to RenderingWindow::draw being called. This is
intended to be used for any required setup / state initialisation and is
called once for each pass in the effect.
\param pass
Indicates the pass number to be initialised (starting at pass 0).
\note
Note that this function is called \e after any standard state
initialisation that might be peformed by the Renderer module.
*/
virtual void performPreRenderFunctions(const int pass) = 0;
/*!
\brief
Function called after RenderingWindow::draw is called. This is intended
to be used for any required cleanup / state restoration. This function
is called <em>once only</em>, unlike performPreRenderFunctions which may
be called multiple times; once for each pass in the effect.
\note
Note that this function is called \e before any standard state
cleanup that might be peformed by the Renderer module.
*/
virtual void performPostRenderFunctions() = 0;
/*!
\brief
Function called to generate geometry for the RenderingWindow.
The geometry generated should be fully unclipped and window local. The
origin for the geometry is located at the top-left corner.
\param window
The RenderingWindow object that is being processed.
\param geometry
GeometryBuffer object where the generated geometry should be added.
This object will be cleared before this function is invoked.
\return
boolean value indicating whether the RenderingWindow should generate
it's own geometry.
- true if the RenderingWindow should generate it's own geometry. You
will usually only return true if you do not need to use custom geometry.
- false if you have added any required geometry needed to represent the
RenderingWindow.
*/
virtual bool realiseGeometry(RenderingWindow& window,
GeometryBuffer& geometry) = 0;
/*!
\brief
Function called to perform any time based updates on the RenderEffect
state.
\note
This function should only affect the internal state of the RenderEffect
object. This function should definitely \e not be used to directly
affect any render states of the underlying rendering API or engine.
\param elapsed
The number of seconds that have elapsed since the last time this
function was called.
\param window
RenderingWindow object that the RenderEffect is being applied to.
\return
boolean that indicates whether the window geometry will still be valid
after the update.
*/
virtual bool update(const float elapsed, RenderingWindow& window) = 0;
};
} // End of CEGUI namespace section
#endif // end of guard _CEGUIRenderEffect_h_
|