deEffect Class Reference
Effect Class. More...
#include <deEffect.h>
Inheritance diagram for deEffect:
Public Types | |
| typedef deTObjectReference< deEffect > | Ref |
| Type holding strong reference. More... | |
 Public Types inherited from deResource | |
| typedef deTObjectReference< deResource > | Ref |
| Type holding strong reference. More... | |
| Public Types inherited from deObject | |
| typedef deTObjectReference< deObject > | Ref |
| Type holding strong reference. More... | |
Public Member Functions | |
Management | |
| bool | GetEnabled () const |
| Effect is enabled. More... | |
| void | SetEnabled (bool enabled) |
| Set if effect is enabled. More... | |
System Peers | |
| deBaseGraphicEffect * | GetPeerGraphic () const |
| Graphic system peer object. More... | |
| void | SetPeerGraphic (deBaseGraphicEffect *peer) |
| Set graphic system peer object. More... | |
| Public Member Functions inherited from deResource | |
| deResourceManager * | GetResourceManager () const |
| Resource manager or NULL if resource is leaking. More... | |
| deEngine * | GetEngine () const |
| Game engine object from resource manager. More... | |
| deResource * | GetLLManagerPrev () const |
| Previous resource in the resource manager linked list. More... | |
| void | SetLLManagerPrev (deResource *resource) |
| Set next resource in the resource manager linked list. More... | |
| deResource * | GetLLManagerNext () const |
| Next resource in the resource manager linked list. More... | |
| void | SetLLManagerNext (deResource *resource) |
| Set next resource in the resource manager linked list. More... | |
| void | MarkLeaking () |
| Marks the resource leaking. More... | |
| deResource (deResourceManager *resourceManager) | |
| Create resource. More... | |
| Public Member Functions inherited from deObject | |
| int | GetRefCount () const |
| Reference count. More... | |
| void | AddReference () |
| Add reference increasing reference count by 1. More... | |
| void | FreeReference () |
| Decrease reference count by one and delete object if count reaches 0. More... | |
| deObject () | |
| Create object with reference count of 1. More... | |
Constructors and Destructors | |
| deEffect (deEffectManager *manager) | |
| Create new world object with the given resource manager. More... | |
| virtual | ~deEffect () |
| Clean up world. More... | |
Visiting | |
| virtual void | Visit (deEffectVisitor &visitor) |
| Visit effect. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from deResource | |
| virtual | ~deResource () |
| Clean up resource. More... | |
| Protected Member Functions inherited from deObject | |
| virtual | ~deObject () |
| Clean up object. More... | |
Detailed Description
Effect Class.
Effects describe alterations of a world before it is rendered. Such effects can alter the final image ( called post processing ) or alter the state of some objects. Various effects can be combined to achieve all sorts of complex effects.
Member Typedef Documentation
◆ Ref
| typedef deTObjectReference<deEffect> deEffect::Ref |
Type holding strong reference.
Constructor & Destructor Documentation
◆ deEffect()
| deEffect::deEffect | ( | deEffectManager * | manager | ) |
Create new world object with the given resource manager.
◆ ~deEffect()
|
protectedvirtual |
Clean up world.
- Note
- Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.
Member Function Documentation
◆ GetEnabled()
|
inline |
Effect is enabled.
◆ GetPeerGraphic()
|
inline |
Graphic system peer object.
◆ SetEnabled()
| void deEffect::SetEnabled | ( | bool | enabled | ) |
Set if effect is enabled.
◆ SetPeerGraphic()
| void deEffect::SetPeerGraphic | ( | deBaseGraphicEffect * | peer | ) |
Set graphic system peer object.
◆ Visit()
|
virtual |
Visit effect.
Reimplemented in deEffectOverlayImage, deEffectFilterKernel, deEffectDistortImage, and deEffectColorMatrix.
The documentation for this class was generated from the following file:
