PLRenderer::EffectTechnique Class Reference

Effect technique class. More...

#include <EffectTechnique.h>

List of all members.

Public Member Functions
Effect &	GetEffect () const
	Returns the owner effect.
bool	IsValid () const
	Returns whether the technique is valid or not.
void	SetValid (bool bValid)
	Sets whether the technique is valid or not.
PLCore::String	GetName () const
	Gets the name of the technique.
void	SetName (const PLCore::String &sName="")
	Sets the name of the technique.
PLCore::uint32	GetNumOfPasses () const
	Gets the number of render passes the technique is using.
PLRENDERER_API EffectPass *	AddPass (int nIndex=-1)
	Adds a pass.
PLRENDERER_API bool	RemovePass (PLCore::uint32 nIndex=0)
	Removes a pass.
PLRENDERER_API void	RemoveAllPasses ()
	Removes all passes.
EffectPass *	GetPass (PLCore::uint32 nIndex=0) const
	Gets a pass.
PLRENDERER_API bool	SetupPass (PLCore::uint32 nIndex=0, ParameterManager *pParameterManager=nullptr) const
	Setup the given path.

---

Detailed Description

Effect technique class.

---

Member Function Documentation

Effect & PLRenderer::EffectTechnique::GetEffect

(

)

const [inline]

Returns the owner effect.

Returns:

Owner effect

bool PLRenderer::EffectTechnique::IsValid

(

)

const [inline]

Returns whether the technique is valid or not.

Returns:

'true' if the technique is valid, else 'false'

Remarks:

If an technique is invalid for instance because an used shader isn't supported by the hardware you shouldn't use this technique because it may produce ugly results!

void PLRenderer::EffectTechnique::SetValid

(

bool

bValid

)

[inline]

Sets whether the technique is valid or not.

Parameters:

[in]

bValid

Technique valid?

PLCore::String PLRenderer::EffectTechnique::GetName

(

)

const [inline]

Gets the name of the technique.

Returns:

Name of the technique

void PLRenderer::EffectTechnique::SetName

(

const PLCore::String &

sName = ""

)

[inline]

Sets the name of the technique.

Parameters:

[in]

sName

New technique name

PLCore::uint32 PLRenderer::EffectTechnique::GetNumOfPasses

(

)

const [inline]

Gets the number of render passes the technique is using.

Returns:

Number of passes

PLRENDERER_API EffectPass* PLRenderer::EffectTechnique::AddPass

(

int

nIndex = -1

)

Adds a pass.

Parameters:

[in]

nIndex

Pass index in the technique where to add the new pass, if < 0 add at the end

Returns:

The new pass, a null pointer on error

PLRENDERER_API bool PLRenderer::EffectTechnique::RemovePass

(

PLCore::uint32

nIndex = 0

)

Removes a pass.

Parameters:

[in]

nIndex

Pass index in the technique to remove

Returns:

'true' if all went fine, else 'false'

PLRENDERER_API void PLRenderer::EffectTechnique::RemoveAllPasses

(

)

Removes all passes.

EffectPass * PLRenderer::EffectTechnique::GetPass

(

PLCore::uint32

nIndex = 0

)

const [inline]

Gets a pass.

Parameters:

[in]

nIndex

Pass index in the technique

Returns:

The requested pass, a null pointer on error

PLRENDERER_API bool PLRenderer::EffectTechnique::SetupPass	(	PLCore::uint32	nIndex = 0,
		ParameterManager *	pParameterManager = nullptr
	)		const

Setup the given path.

Parameters:

[in]	nIndex	Index of the path to setup
[in]	pParameterManager	Parameters set instead of existing effect parameters, if a null pointer, use THIS parameter manager

Returns:

'true' if all went fine, else 'false'

---

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

• EffectTechnique.h
• EffectTechnique.inl