Public Types | Public Member Functions

xl7::direct3d::rendering::Effect Class Reference

#include <Effect.h>

Inheritance diagram for xl7::direct3d::rendering::Effect:
xl7::direct3d::rendering::RenderTargetHost xl7::direct3d::rendering::IRenderable xl7::direct3d::rendering::PostEffect xl7::direct3d::rendering::SceneEffect gl7::repository::effect::ComicStyleEffect gl7::repository::effect::OutliningEffect gl7::repository::effect::TexturedPhongEffect

List of all members.

Public Types

typedef std::vector< Pass * > Passes

Public Member Functions

 Effect (const cl7::string_type &name, Chain *chain)
virtual ~Effect (void)
const cl7::string_typeGetName () const
const ChainGetChain () const
const PassesGetPasses () const
bool IsEnabled () const
ChainGetChain ()
PassesGetPasses ()
void Enable ()
void Disable ()
bool _Begin ()
bool _End ()
bool _RenderNextPass (scene::SceneGraph *scene_graph)
bool Render (scene::SceneGraph *scene_graph)

Detailed Description

Represents a step within the effect chain covering the whole rendering process of the current scene. An effect may assemble several effect passes.


Member Typedef Documentation


Constructor & Destructor Documentation

xl7::direct3d::rendering::Effect::Effect ( const cl7::string_type name,
Chain chain 
)

Explicit constructor.

xl7::direct3d::rendering::Effect::~Effect ( void   )  [virtual]

Destructor.


Member Function Documentation

bool xl7::direct3d::rendering::Effect::_Begin (  ) 

Begins the effect.

bool xl7::direct3d::rendering::Effect::_End (  ) 

Ends the effect.

bool xl7::direct3d::rendering::Effect::_RenderNextPass ( scene::SceneGraph scene_graph  ) 

Begins, runs, and ends the next pass. Returns true, if there are passes left to run, or false, if no more passes left.

void xl7::direct3d::rendering::Effect::Disable (  )  [inline]

Disables this effect.

void xl7::direct3d::rendering::Effect::Enable (  )  [inline]

Enables this effect.

Chain* xl7::direct3d::rendering::Effect::GetChain (  )  [inline]

Returns the superior chain of this effect.

const Chain* xl7::direct3d::rendering::Effect::GetChain (  )  const [inline]

Returns the superior chain of this effect.

const cl7::string_type& xl7::direct3d::rendering::Effect::GetName (  )  const [inline]

Returns the name of this effect.

Passes* xl7::direct3d::rendering::Effect::GetPasses (  )  [inline]

Returns the list of passes.

const Passes* xl7::direct3d::rendering::Effect::GetPasses (  )  const [inline]

Returns the list of passes.

bool xl7::direct3d::rendering::Effect::IsEnabled (  )  const [inline]

Returns the flag indicating whether this effect is enabled and thus will be executed within the effect chain (or not, if disabled).

bool xl7::direct3d::rendering::Effect::Render ( scene::SceneGraph scene_graph  )  [virtual]

Performs the complete rendering progress.

Implements xl7::direct3d::rendering::IRenderable.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines