Pyrogenesis  trunk
Public Member Functions | Private Attributes | List of all members
LitRenderModifier Class Reference

Class LitRenderModifier: Abstract base class for RenderModifiers that apply a shadow map. More...

#include <RenderModifiers.h>

Inheritance diagram for LitRenderModifier:
Inheritance graph
[legend]
Collaboration diagram for LitRenderModifier:
Collaboration graph
[legend]

Public Member Functions

 LitRenderModifier ()
 
 ~LitRenderModifier ()
 
void SetShadowMap (const ShadowMap *shadow)
 SetShadowMap: Set the shadow map that will be used for rendering. More...
 
void SetLightEnv (const CLightEnv *lightenv)
 SetLightEnv: Set the light environment that will be used for rendering. More...
 
const ShadowMapGetShadowMap () const
 
const CLightEnvGetLightEnv () const
 
- Public Member Functions inherited from RenderModifier
 RenderModifier ()
 
virtual ~RenderModifier ()
 
virtual void BeginPass (const CShaderProgramPtr &shader)=0
 BeginPass: Setup OpenGL for the given rendering pass. More...
 
virtual void PrepareModel (const CShaderProgramPtr &shader, CModel *model)=0
 PrepareModel: Called before rendering the given model. More...
 

Private Attributes

const ShadowMapm_Shadow
 
const CLightEnvm_LightEnv
 

Detailed Description

Class LitRenderModifier: Abstract base class for RenderModifiers that apply a shadow map.

LitRenderModifiers expect the diffuse brightness in the primary color (instead of ambient + diffuse).

Constructor & Destructor Documentation

LitRenderModifier::LitRenderModifier ( )
LitRenderModifier::~LitRenderModifier ( )

Member Function Documentation

const CLightEnv* LitRenderModifier::GetLightEnv ( ) const
inline
const ShadowMap* LitRenderModifier::GetShadowMap ( ) const
inline
void LitRenderModifier::SetLightEnv ( const CLightEnv lightenv)

SetLightEnv: Set the light environment that will be used for rendering.

Must be called by the user of the RenderModifier.

Parameters
lightenvthe light environment (must be non-null)
void LitRenderModifier::SetShadowMap ( const ShadowMap shadow)

SetShadowMap: Set the shadow map that will be used for rendering.

Must be called by the user of the RenderModifier.

The shadow map must be non-null and use depth texturing, or subsequent rendering using this RenderModifier will fail.

Parameters
shadowthe shadow map

Member Data Documentation

const CLightEnv* LitRenderModifier::m_LightEnv
private
const ShadowMap* LitRenderModifier::m_Shadow
private

The documentation for this class was generated from the following files: