PLRenderer::EffectPassLayer Class Reference

Effect pass layer class. More...

#include <EffectPassLayer.h>

List of all members.

Public Member Functions
EffectPass &	GetPass () const
	Returns the layer owner.
PLRENDERER_API bool	Bind (PLCore::uint32 nStage, ParameterManager *pParameterManager=nullptr) const
	Makes the texture buffer of the texture handlers texture to the current renderer texture buffer.
PLCore::String	GetTexture () const
	Returns the name of the used texture parameter.
void	SetTexture (const PLCore::String &sTexture)
	Sets the name of the used texture parameter.
SamplerStates &	GetSamplerStates ()
	Returns the sampler states.
const SamplerStates &	GetSamplerStates () const
FixedFunctionsTextureStageStates &	GetFixedFunctionsTextureStageStates ()
	Returns the fixed functions texture stage states.
const FixedFunctionsTextureStageStates &	GetFixedFunctionsTextureStageStates () const
EffectPassLayer &	operator= (const EffectPassLayer &cSource)
	Copy operator.

---

Detailed Description

Effect pass layer class.

---

Member Function Documentation

EffectPass & PLRenderer::EffectPassLayer::GetPass

(

)

const [inline]

Returns the layer owner.

Returns:

The layer owner

PLRENDERER_API bool PLRenderer::EffectPassLayer::Bind	(	PLCore::uint32	nStage,
		ParameterManager *	pParameterManager = nullptr
	)		const

Makes the texture buffer of the texture handlers texture to the current renderer texture buffer.

Parameters:

[in]	nStage	Which texture stage?
[in]	pParameterManager	Parameters set instead of existing effect parameters, can be a null pointer

Returns:

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

Note:

• The texture handlers texture transformation matrix is also set!
• If there's no texture parameter name or an invalid one no texture is bound

PLCore::String PLRenderer::EffectPassLayer::GetTexture

(

)

const [inline]

Returns the name of the used texture parameter.

Returns:

The name of the used texture parameter

void PLRenderer::EffectPassLayer::SetTexture

(

const PLCore::String &

sTexture

)

[inline]

Sets the name of the used texture parameter.

Parameters:

[in]

sTexture

The name of the used texture parameter

SamplerStates & PLRenderer::EffectPassLayer::GetSamplerStates

(

)

[inline]

Returns the sampler states.

Returns:

The sampler states

const SamplerStates & PLRenderer::EffectPassLayer::GetSamplerStates

(

)

const [inline]

FixedFunctionsTextureStageStates & PLRenderer::EffectPassLayer::GetFixedFunctionsTextureStageStates

(

)

[inline]

Returns the fixed functions texture stage states.

Returns:

The fixed functions texture stage states

const FixedFunctionsTextureStageStates & PLRenderer::EffectPassLayer::GetFixedFunctionsTextureStageStates

(

)

const [inline]

EffectPassLayer & PLRenderer::EffectPassLayer::operator=

(

const EffectPassLayer &

cSource

)

[inline]

Copy operator.

Parameters:

[in]

cSource

Source to copy from

Returns:

This instance

---

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

• EffectPassLayer.h
• EffectPassLayer.inl