Frame::FrameShader Class Reference
#include <frameshader.h>
Inheritance diagram for Frame::FrameShader:
Detailed Description
A FrameShader controls the rendering of an entire frame, and is configured by an XML file.(C) 2007 Radon Labs GmbH
Public Member Functions | |
| FrameShader () | |
| constructor | |
| virtual | ~FrameShader () |
| destructor | |
| void | Discard () |
| discard the frame shader | |
| void | Render () |
| render the frame shader from the given camera | |
| void | SetName (const Resources::ResourceId &id) |
| set the name of the frame shader | |
|
const Resources::ResourceId & | GetName () const |
| get the name of the frame shader | |
| void | SetMainRenderTarget (const Ptr< CoreGraphics::RenderTarget > &rt) |
| set the main render target | |
|
const Ptr < CoreGraphics::RenderTarget > & | GetMainRenderTarget () const |
| get the main render target | |
| void | AddRenderTarget (const Resources::ResourceId &resId, const Ptr< CoreGraphics::RenderTarget > &rt) |
| add a render target to the frame | |
| SizeT | GetNumRenderTargets () const |
| get number of render targets | |
|
const Ptr < CoreGraphics::RenderTarget > & | GetRenderTargetByIndex (IndexT i) const |
| get render target by index | |
| bool | HasRenderTarget (const Resources::ResourceId &resId) const |
| return true if render target exists by name | |
|
const Ptr < CoreGraphics::RenderTarget > & | GetRenderTargetByName (const Resources::ResourceId &resId) const |
| get render target by name | |
| void | AddFramePass (const Ptr< FramePass > &framePass) |
| add a frame pass to the frame shader | |
| SizeT | GetNumFramePasses () const |
| get number of frame passes | |
| const Ptr< FramePass > & | GetFramePassByIndex (IndexT i) const |
| get frame pass by index | |
| bool | HasFramePass (const Resources::ResourceId &resId) const |
| return true if names pass exists | |
| const Ptr< FramePass > & | GetFramePassByName (const Resources::ResourceId &resId) const |
| get frame pass by name | |
| void | AddPostEffect (const Ptr< FramePostEffect > &postEffect) |
| add a post effect to the frame shader | |
| SizeT | GetNumPostEffects () const |
| get number of post effects | |
|
const Ptr < FramePostEffect > & | GetPostEffectByIndex (IndexT i) const |
| get post effect by index | |
| bool | HasPostEffect (const Resources::ResourceId &resId) const |
| return true if post effect exists | |
|
const Ptr < FramePostEffect > & | GetPostEffectByName (const Resources::ResourceId &resId) const |
| get post effect by name | |
| int | GetRefCount () const |
| get the current refcount | |
| void | AddRef () |
| increment refcount by one | |
| void | Release () |
| decrement refcount and destroy object if refcount is zero | |
| bool | IsInstanceOf (const Rtti &rtti) const |
| return true if this object is instance of given class | |
| bool | IsInstanceOf (const Util::String &className) const |
| return true if this object is instance of given class by string | |
| bool | IsInstanceOf (const Util::FourCC &classFourCC) const |
| return true if this object is instance of given class by fourcc | |
| bool | IsA (const Rtti &rtti) const |
| return true if this object is instance of given class, or a derived class | |
| bool | IsA (const Util::String &rttiName) const |
| return true if this object is instance of given class, or a derived class, by string | |
| bool | IsA (const Util::FourCC &rttiFourCC) const |
| return true if this object is instance of given class, or a derived class, by fourcc | |
| const Util::String & | GetClassName () const |
| get the class name | |
| Util::FourCC | GetClassFourCC () const |
| get the class FourCC code | |
Static Public Member Functions | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!) | |
Member Function Documentation
| int Core::RefCounted::GetRefCount | ( | ) | const [inline, inherited] |
get the current refcount
Return the current refcount of the object.
| void Core::RefCounted::AddRef | ( | ) | [inline, inherited] |
increment refcount by one
Increment the refcount of the object.
| void Core::RefCounted::Release | ( | ) | [inline, inherited] |
decrement refcount and destroy object if refcount is zero
Decrement the refcount and destroy object if refcount is zero.
| const Util::String & Core::RefCounted::GetClassName | ( | ) | const [inline, inherited] |
get the class name
Get the class name of the object.
| Util::FourCC Core::RefCounted::GetClassFourCC | ( | ) | const [inline, inherited] |
get the class FourCC code
Get the class FourCC of the object.
| void Core::RefCounted::DumpRefCountingLeaks | ( | ) | [static, inherited] |
dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)
This method should be called as the very last before an application exits.