PLRenderer::SamplerStates Class Reference

Sampler states RTTI wrapper class. More...

#include <SamplerStates.h>

Inheritance diagram for PLRenderer::SamplerStates:

List of all members.

Public Member Functions
TextureAddressing::Enum	GetAddressU () const
void	SetAddressU (TextureAddressing::Enum nValue)
TextureAddressing::Enum	GetAddressV () const
void	SetAddressV (TextureAddressing::Enum nValue)
TextureAddressing::Enum	GetAddressW () const
void	SetAddressW (TextureAddressing::Enum nValue)
TextureFiltering::Enum	GetMagFilter () const
void	SetMagFilter (TextureFiltering::Enum nValue)
TextureFiltering::Enum	GetMinFilter () const
void	SetMinFilter (TextureFiltering::Enum nValue)
TextureFiltering::Enum	GetMipFilter () const
void	SetMipFilter (TextureFiltering::Enum nValue)
float	GetMipmapLODBias () const
void	SetMipmapLODBias (float fValue)
PLCore::uint32	GetMaxMapLevel () const
void	SetMaxMapLevel (int nValue)
PLCore::uint32	GetMaxAnisotropy () const
void	SetMaxAnisotropy (PLCore::uint32 nValue)
PLRENDERER_API	SamplerStates ()
	Constructor.
PLRENDERER_API	SamplerStates (const SamplerStates &cSource)
	Copy constructor.
virtual PLRENDERER_API	~SamplerStates ()
	Destructor.
PLCore::uint32	Get (Sampler::Enum nState) const
	Retrieves a sampler-state value.
bool	Set (Sampler::Enum nState, PLCore::uint32 nValue)
	Sets a single sampler-state parameter.
SamplerStates &	operator= (const SamplerStates &cSource)
	Copy operator.

---

Detailed Description

Sampler states RTTI wrapper class.

---

Constructor & Destructor Documentation

PLRENDERER_API PLRenderer::SamplerStates::SamplerStates

(

)

Constructor.

PLRENDERER_API PLRenderer::SamplerStates::SamplerStates

(

const SamplerStates &

cSource

)

Copy constructor.

Parameters:

[in]

cSource

Source to copy from

virtual PLRENDERER_API PLRenderer::SamplerStates::~SamplerStates

(

)

[virtual]

Destructor.

---

Member Function Documentation

TextureAddressing::Enum PLRenderer::SamplerStates::GetAddressU

(

)

const [inline]

void PLRenderer::SamplerStates::SetAddressU

(

TextureAddressing::Enum

nValue

)

[inline]

TextureAddressing::Enum PLRenderer::SamplerStates::GetAddressV

(

)

const [inline]

void PLRenderer::SamplerStates::SetAddressV

(

TextureAddressing::Enum

nValue

)

[inline]

TextureAddressing::Enum PLRenderer::SamplerStates::GetAddressW

(

)

const [inline]

void PLRenderer::SamplerStates::SetAddressW

(

TextureAddressing::Enum

nValue

)

[inline]

TextureFiltering::Enum PLRenderer::SamplerStates::GetMagFilter

(

)

const [inline]

void PLRenderer::SamplerStates::SetMagFilter

(

TextureFiltering::Enum

nValue

)

[inline]

TextureFiltering::Enum PLRenderer::SamplerStates::GetMinFilter

(

)

const [inline]

void PLRenderer::SamplerStates::SetMinFilter

(

TextureFiltering::Enum

nValue

)

[inline]

TextureFiltering::Enum PLRenderer::SamplerStates::GetMipFilter

(

)

const [inline]

void PLRenderer::SamplerStates::SetMipFilter

(

TextureFiltering::Enum

nValue

)

[inline]

float PLRenderer::SamplerStates::GetMipmapLODBias

(

)

const [inline]

void PLRenderer::SamplerStates::SetMipmapLODBias

(

float

fValue

)

[inline]

PLCore::uint32 PLRenderer::SamplerStates::GetMaxMapLevel

(

)

const [inline]

void PLRenderer::SamplerStates::SetMaxMapLevel

(

int

nValue

)

[inline]

PLCore::uint32 PLRenderer::SamplerStates::GetMaxAnisotropy

(

)

const [inline]

void PLRenderer::SamplerStates::SetMaxAnisotropy

(

PLCore::uint32

nValue

)

[inline]

PLCore::uint32 PLRenderer::SamplerStates::Get

(

Sampler::Enum

nState

)

const [inline]

Retrieves a sampler-state value.

Parameters:

[in]

nState

State variable that is being queried. This parameter can be any member of the sampler enumerated type.

Returns:

The value of the queried sampler state variable

bool PLRenderer::SamplerStates::Set	(	Sampler::Enum	nState,
		PLCore::uint32	nValue
	)		[inline]

Sets a single sampler-state parameter.

Parameters:

[in]	nState	State variable that is being modified. This parameter can be any member of the sampler enumerated type.
[in]	nValue	New value for the sampler state to be set. The meaning of this parameter is dependent on the value specified for nState. For example, if nState is Sampler::AddressU, the second parameter must be one member of the Sampler::AddressU enumerated type. (e.g. TextureAddressing::Wrap) You can also set the value to unknown - then this state is ignored.

Returns:

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

SamplerStates & PLRenderer::SamplerStates::operator=

(

const SamplerStates &

cSource

)

[inline]

Copy operator.

Parameters:

[in]

cSource

Source to copy from

Returns:

This class

---

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

• SamplerStates.h
• SamplerStates.inl