CrystalSpace

Public API Reference

iRenderManagerPostEffects Struct Reference

Interface to add post-effects layers. More...

#include <iengine/rendermanager.h>

Inheritance diagram for iRenderManagerPostEffects:

List of all members.

Public Member Functions

virtual void AddPostEffect (CS::RenderManager::iPostEffect *effect)=0
 Add an effect at the end of the chain of effects.
virtual csPtr
< CS::RenderManager::iPostEffect
CreatePostEffect (const char *name) const =0
 Create a new post effect.
virtual void DrawPostEffects (CS::RenderManager::RenderTreeBase &renderTree)=0
 Draw all the effects in the chain of effects.
virtual size_t FindPostEffect (const char *name) const =0
 Find the index of the post effect with the given name, or (size_t) ~0 if it is not found.
virtual iTextureHandleGetDepthTarget () const =0
 Get the depth texture to render.
virtual iTextureHandleGetEffectsOutputTarget () const =0
 Get the render target used to ultimatively render to.
virtual
CS::RenderManager::iPostEffect
GetPostEffect (size_t index)=0
 Get the effect at the given position.
virtual size_t GetPostEffectCount () const =0
 Get the total number of effects.
virtual iTextureHandleGetScreenTarget () const =0
 Get the texture to render a scene to for post processing.
virtual bool InsertPostEffect (CS::RenderManager::iPostEffect *effect, size_t index)=0
 Insert an effect before the effect at position index.
virtual bool RemovePostEffect (CS::RenderManager::iPostEffect *effect)=0
 Remove the given effect from the chain of effects.
virtual bool RemovePostEffect (size_t index)=0
 Remove the effect at the given position.
virtual bool ScreenSpaceYFlipped () const =0
 Returns whether the screen space is flipped in Y direction.
virtual void SetDepthBuffer (iTextureHandle *depth)=0
 Sets the depth buffer so that the post effect can access the depth.
virtual void SetEffectsOutputTarget (iTextureHandle *tex)=0
 Set the render target used to ultimatively render to.
virtual void SetPostEffectsEnabled (bool status)=0
 Enables/Disables the post effects.
virtual bool SetupView (iView *view, CS::Math::Matrix4 &perspectiveFixup)=0
 Set up post processing manager for a view.

Detailed Description

Interface to add post-effects layers.

Definition at line 106 of file rendermanager.h.


Member Function Documentation

virtual void iRenderManagerPostEffects::AddPostEffect ( CS::RenderManager::iPostEffect effect  )  [pure virtual]

Add an effect at the end of the chain of effects.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual csPtr<CS::RenderManager::iPostEffect> iRenderManagerPostEffects::CreatePostEffect ( const char *  name  )  const [pure virtual]

Create a new post effect.

You must still add it to the chain of effects through AddPostEffect() or InsertPostEffect().

Implemented in CS::RenderManager::PostEffectsSupport.

virtual void iRenderManagerPostEffects::DrawPostEffects ( CS::RenderManager::RenderTreeBase renderTree  )  [pure virtual]

Draw all the effects in the chain of effects.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual size_t iRenderManagerPostEffects::FindPostEffect ( const char *  name  )  const [pure virtual]

Find the index of the post effect with the given name, or (size_t) ~0 if it is not found.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual iTextureHandle* iRenderManagerPostEffects::GetDepthTarget (  )  const [pure virtual]

Get the depth texture to render.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual iTextureHandle* iRenderManagerPostEffects::GetEffectsOutputTarget (  )  const [pure virtual]

Get the render target used to ultimatively render to.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual CS::RenderManager::iPostEffect* iRenderManagerPostEffects::GetPostEffect ( size_t  index  )  [pure virtual]

Get the effect at the given position.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual size_t iRenderManagerPostEffects::GetPostEffectCount (  )  const [pure virtual]

Get the total number of effects.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual iTextureHandle* iRenderManagerPostEffects::GetScreenTarget (  )  const [pure virtual]

Get the texture to render a scene to for post processing.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual bool iRenderManagerPostEffects::InsertPostEffect ( CS::RenderManager::iPostEffect effect,
size_t  index 
) [pure virtual]

Insert an effect before the effect at position index.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual bool iRenderManagerPostEffects::RemovePostEffect ( CS::RenderManager::iPostEffect effect  )  [pure virtual]

Remove the given effect from the chain of effects.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual bool iRenderManagerPostEffects::RemovePostEffect ( size_t  index  )  [pure virtual]

Remove the effect at the given position.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual bool iRenderManagerPostEffects::ScreenSpaceYFlipped (  )  const [pure virtual]

Returns whether the screen space is flipped in Y direction.

This usually happens when rendering to a texture due post effects.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual void iRenderManagerPostEffects::SetDepthBuffer ( iTextureHandle depth  )  [pure virtual]

Sets the depth buffer so that the post effect can access the depth.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual void iRenderManagerPostEffects::SetEffectsOutputTarget ( iTextureHandle tex  )  [pure virtual]

Set the render target used to ultimatively render to.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual void iRenderManagerPostEffects::SetPostEffectsEnabled ( bool  status  )  [pure virtual]

Enables/Disables the post effects.

Implemented in CS::RenderManager::PostEffectsSupport.

virtual bool iRenderManagerPostEffects::SetupView ( iView view,
CS::Math::Matrix4 perspectiveFixup 
) [pure virtual]

Set up post processing manager for a view.

Returns:
Whether the manager has changed. If true some values, such as the screen texture, must be reobtained from the manager. perspectiveFixup returns a matrix that should be applied after the normal perspective matrix (this is needed as the screen texture may be larger than the desired viewport and thus the projection must be corrected for that).

Implemented in CS::RenderManager::PostEffectsSupport.


The documentation for this struct was generated from the following file:

Generated for Crystal Space 2.1 by doxygen 1.6.1