This is a manager for the effect resource. More...

Inheritance diagram for PLRenderer::EffectManager:

Public Member Functions
RendererContext &	GetRendererContext () const
	Returns the owner renderer context of this manager.
PLRENDERER_API bool	ReloadEffects ()
	Reloads all effects.
PLRENDERER_API bool	Use (const PLCore::String &sName=Default)
	Uses a given effect.
Static Public Attributes
static PLRENDERER_API const PLCore::String	Default

Detailed Description

This is a manager for the effect resource.

Note:

Unloads unused resources automatically by default
The public static effect strings within this class are just filenames without any fixed functionality

Member Function Documentation

RendererContext & PLRenderer::EffectManager::GetRendererContext ( ) const [inline]

Returns the owner renderer context of this manager.

PLRENDERER_API bool PLRenderer::EffectManager::ReloadEffects ( )

Reloads all effects.

PLRENDERER_API bool PLRenderer::EffectManager::Use ( const PLCore::String & sName = Default )

Uses a given effect.

Parameters:

[in] sName Name of the effect to use

Remarks:: This function is calling the Bind() and SetupPass(0) function of the given effect. The name is in fact the filename of the effect. It's recommended to use only the predefined names within this class within this function because this resources are loaded and marked as protected by default. If you use any other effect, ensure that this effect is protected in order to avoid frequently loading/destruction of the resource in the worst case. It's recommended to use this function ONLY if you want to set 'some known' render states without doing this by hand.

Default effect, ('Default') dynamically created within the 'EffectManager'-constructor

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