Ogre::HlmsSamplerblock Struct Reference

A sampler block contains settings that go hand in hand with a texture, and thus are common to many textures. More...

#include <OgreHlmsSamplerblock.h>

Inheritance diagram for Ogre::HlmsSamplerblock:

Public Member Functions
	HlmsSamplerblock ()
bool	operator!= (const HlmsSamplerblock &_r) const
void	setAddressingMode (TextureAddressingMode addressingMode)
void	setFiltering (TextureFilterOptions filterType)
	Helper function to set filtering to the most common settings.

Public Attributes
uint8	mAllowGlobalDefaults
	When zero, HlmsManager cannot override the block's values with enforced global settings.
uint8	mBlockType
ColourValue	mBorderColour
CompareFunction	mCompareFunction
	Defaults to NUM_COMPARE_FUNCTIONS which means disabled.
uint16	mId
	The mId is only valid while mRefCount > 0; which means mRsData may contain valid data, else it's null.
uint16	mLifetimeId
	Except for HlmsSamplerblocks, mLifetimeId is valid throghout the entire life of HlmsManager.
FilterOptions	mMagFilter
float	mMaxAnisotropy
float	mMaxLod
FilterOptions	mMinFilter
float	mMinLod
FilterOptions	mMipFilter
Real	mMipLodBias
	This allows you to adjust the mipmap calculation up or down for a given texture unit.
uint16	mRefCount
	Render-System specific data.
void *	mRsData
TextureAddressingMode	mU
TextureAddressingMode	mV
TextureAddressingMode	mW

Detailed Description

A sampler block contains settings that go hand in hand with a texture, and thus are common to many textures.

This is very analogous to D3D11_SAMPLER_DESC. @See HlmsDatablock Up to 32 different blocks are allowed!

Constructor & Destructor Documentation

HlmsSamplerblock()

Ogre::HlmsSamplerblock::HlmsSamplerblock

(

)

Member Function Documentation

operator!=()

bool Ogre::HlmsSamplerblock::operator!= ( const HlmsSamplerblock &  _r ) const

inline

setAddressingMode()

void Ogre::HlmsSamplerblock::setAddressingMode

(

TextureAddressingMode

addressingMode

)

setFiltering()

void Ogre::HlmsSamplerblock::setFiltering

(

TextureFilterOptions

filterType

)

Helper function to set filtering to the most common settings.

Member Data Documentation

mAllowGlobalDefaults

uint8 Ogre::BasicBlock::mAllowGlobalDefaults

inherited

When zero, HlmsManager cannot override the block's values with enforced global settings.

See also

HlmsBasicBlock (such as lower quality texture filtering or turning off depth checks for debugging)

mBlockType

uint8 Ogre::BasicBlock::mBlockType

inherited

mBorderColour

ColourValue Ogre::HlmsSamplerblock::mBorderColour

mCompareFunction

CompareFunction Ogre::HlmsSamplerblock::mCompareFunction

Defaults to NUM_COMPARE_FUNCTIONS which means disabled.

mId

uint16 Ogre::BasicBlock::mId

inherited

The mId is only valid while mRefCount > 0; which means mRsData may contain valid data, else it's null.

mLifetimeId

uint16 Ogre::BasicBlock::mLifetimeId

inherited

Except for HlmsSamplerblocks, mLifetimeId is valid throghout the entire life of HlmsManager.

This guarantees HlmsMacroblock & HlmsBlendblock pointers are always valid, although they may be inactive (i.e. mId invalid, mRefCount = 0 and mRsData = 0)

mMagFilter

FilterOptions Ogre::HlmsSamplerblock::mMagFilter

mMaxAnisotropy

float Ogre::HlmsSamplerblock::mMaxAnisotropy

mMaxLod

float Ogre::HlmsSamplerblock::mMaxLod

mMinFilter

FilterOptions Ogre::HlmsSamplerblock::mMinFilter

mMinLod

float Ogre::HlmsSamplerblock::mMinLod

mMipFilter

FilterOptions Ogre::HlmsSamplerblock::mMipFilter

mMipLodBias

Real Ogre::HlmsSamplerblock::mMipLodBias

This allows you to adjust the mipmap calculation up or down for a given texture unit.

Negative values force a larger mipmap to be used, positive values force a smaller mipmap to be used. Units are in numbers of levels, so +1 forces the mipmaps to one smaller level.

Note

Only does something if render system has capability RSC_MIPMAP_LOD_BIAS.

mRefCount

uint16 Ogre::BasicBlock::mRefCount

inherited

Render-System specific data.

mRsData

void* Ogre::BasicBlock::mRsData

inherited

mU

TextureAddressingMode Ogre::HlmsSamplerblock::mU

mV

TextureAddressingMode Ogre::HlmsSamplerblock::mV

mW

TextureAddressingMode Ogre::HlmsSamplerblock::mW

---

The documentation for this struct was generated from the following file:

• OgreHlmsSamplerblock.h