irr::video::SMaterialLayer Class Reference

Struct for holding material parameters which exist per texture layer. More...

#include <SMaterialLayer.h>

Public Member Functions
	SMaterialLayer ()
	Default constructor. More...
	SMaterialLayer (const SMaterialLayer &other)
	Copy constructor. More...
	~SMaterialLayer ()
	Destructor. More...
SMaterialLayer &	operator= (const SMaterialLayer &other)
	Assignment operator. More...
core::matrix4 &	getTextureMatrix ()
	Gets the texture transformation matrix. More...
const core::matrix4 &	getTextureMatrix () const
	Gets the immutable texture transformation matrix. More...
void	setTextureMatrix (const core::matrix4 &mat)
	Sets the texture transformation matrix to mat. More...
bool	operator!= (const SMaterialLayer &b) const
	Inequality operator. More...
bool	operator== (const SMaterialLayer &b) const
	Equality operator. More...

Public Attributes
ITexture *	Texture
	Texture. More...
u8	TextureWrapU:4
	Texture Clamp Mode. More...
u8	TextureWrapV:4
u8	TextureWrapW:4
bool	BilinearFilter:1
	Is bilinear filtering enabled? Default: true. More...
bool	TrilinearFilter:1
	Is trilinear filtering enabled? Default: false. More...
u8	AnisotropicFilter
	Is anisotropic filtering enabled? Default: 0, disabled. More...
s8	LODBias
	Bias for the mipmap choosing decision. More...

Friends
class	SMaterial

Detailed Description

Struct for holding material parameters which exist per texture layer.

Definition at line 49 of file SMaterialLayer.h.

Constructor & Destructor Documentation

SMaterialLayer() [1/2]

irr::video::SMaterialLayer::SMaterialLayer ( )

inline

Default constructor.

Definition at line 53 of file SMaterialLayer.h.

                                 : Texture(0), TextureWrapU(ETC_REPEAT), TextureWrapV(ETC_REPEAT), TextureWrapW(ETC_REPEAT),
                        BilinearFilter(true), TrilinearFilter(false), AnisotropicFilter(0), LODBias(0), TextureMatrix(0)
                {
                }

SMaterialLayer() [2/2]

irr::video::SMaterialLayer::SMaterialLayer ( const SMaterialLayer &  other )

inline

Copy constructor.

Parameters

other

Material layer to copy from.

Definition at line 60 of file SMaterialLayer.h.

                {
                        // This pointer is checked during assignment
                        TextureMatrix = 0;
                        *this = other;
                }

~SMaterialLayer()

irr::video::SMaterialLayer::~SMaterialLayer ( )

inline

Destructor.

Definition at line 68 of file SMaterialLayer.h.

                {
                        if ( TextureMatrix )
                        {
                                MatrixAllocator.destruct(TextureMatrix);
                                MatrixAllocator.deallocate(TextureMatrix);
                        }
                }

Member Function Documentation

getTextureMatrix() [1/2]

core::matrix4& irr::video::SMaterialLayer::getTextureMatrix ( )

inline

Gets the texture transformation matrix.

Returns

Texture matrix of this layer.

Definition at line 121 of file SMaterialLayer.h.

                {
                        if (!TextureMatrix)
                        {
                                TextureMatrix = MatrixAllocator.allocate(1);
                                MatrixAllocator.construct(TextureMatrix,core::IdentityMatrix);
                        }
                        return *TextureMatrix;
                }

getTextureMatrix() [2/2]

const core::matrix4& irr::video::SMaterialLayer::getTextureMatrix ( ) const

inline

Gets the immutable texture transformation matrix.

Returns

Texture matrix of this layer.

Definition at line 133 of file SMaterialLayer.h.

                {
                        if (TextureMatrix)
                                return *TextureMatrix;
                        else
                                return core::IdentityMatrix;
                }

operator!=()

bool irr::video::SMaterialLayer::operator!= ( const SMaterialLayer &  b ) const

inline

Inequality operator.

Parameters

b	Layer to compare to.

Returns

True if layers are different, else false.

Definition at line 159 of file SMaterialLayer.h.

                {
                        bool different =
                                Texture != b.Texture ||
                                TextureWrapU != b.TextureWrapU ||
                                TextureWrapV != b.TextureWrapV ||
                                TextureWrapW != b.TextureWrapW ||
                                BilinearFilter != b.BilinearFilter ||
                                TrilinearFilter != b.TrilinearFilter ||
                                AnisotropicFilter != b.AnisotropicFilter ||
                                LODBias != b.LODBias;
                        if (different)
                                return true;
                        else
                                different |= (TextureMatrix != b.TextureMatrix) &&
                                        (!TextureMatrix || !b.TextureMatrix || (*TextureMatrix != *(b.TextureMatrix)));
                        return different;
                }

operator=()

SMaterialLayer& irr::video::SMaterialLayer::operator= ( const SMaterialLayer &  other )

inline

Assignment operator.

Parameters

other

Material layer to copy from.

Returns

This material layer, updated.

Definition at line 80 of file SMaterialLayer.h.

                {
                        // Check for self-assignment!
                        if (this == &other)
                                return *this;

                        Texture = other.Texture;
                        if (TextureMatrix)
                        {
                                if (other.TextureMatrix)
                                        *TextureMatrix = *other.TextureMatrix;
                                else
                                {
                                        MatrixAllocator.destruct(TextureMatrix);
                                        MatrixAllocator.deallocate(TextureMatrix);
                                        TextureMatrix = 0;
                                }
                        }
                        else
                        {
                                if (other.TextureMatrix)
                                {
                                        TextureMatrix = MatrixAllocator.allocate(1);
                                        MatrixAllocator.construct(TextureMatrix,*other.TextureMatrix);
                                }
                                else
                                        TextureMatrix = 0;
                        }
                        TextureWrapU = other.TextureWrapU;
                        TextureWrapV = other.TextureWrapV;
                        TextureWrapW = other.TextureWrapW;
                        BilinearFilter = other.BilinearFilter;
                        TrilinearFilter = other.TrilinearFilter;
                        AnisotropicFilter = other.AnisotropicFilter;
                        LODBias = other.LODBias;

                        return *this;
                }

operator==()

bool irr::video::SMaterialLayer::operator== ( const SMaterialLayer &  b ) const

inline

Equality operator.

Parameters

b	Layer to compare to.

Returns

True if layers are equal, else false.

Definition at line 181 of file SMaterialLayer.h.

                { return !(b!=*this); }

setTextureMatrix()

void irr::video::SMaterialLayer::setTextureMatrix ( const core::matrix4 &  mat )

inline

Sets the texture transformation matrix to mat.

NOTE: Pipelines can ignore this matrix when the texture is 0.

Parameters

mat	New texture matrix for this layer.

Definition at line 145 of file SMaterialLayer.h.

                {
                        if (!TextureMatrix)
                        {
                                TextureMatrix = MatrixAllocator.allocate(1);
                                MatrixAllocator.construct(TextureMatrix,mat);
                        }
                        else
                                *TextureMatrix = mat;
                }

Friends And Related Function Documentation

SMaterial

friend class SMaterial

friend

Definition at line 218 of file SMaterialLayer.h.

Member Data Documentation

AnisotropicFilter

u8 irr::video::SMaterialLayer::AnisotropicFilter

Is anisotropic filtering enabled? Default: 0, disabled.

In Irrlicht you can use anisotropic texture filtering in conjunction with bilinear or trilinear texture filtering to improve rendering results. Primitives will look less blurry with this flag switched on. The number gives the maximal anisotropy degree, and is often in the range 2-16. Value 1 is equivalent to 0, but should be avoided.

Definition at line 208 of file SMaterialLayer.h.

BilinearFilter

bool irr::video::SMaterialLayer::BilinearFilter

Is bilinear filtering enabled? Default: true.

Definition at line 194 of file SMaterialLayer.h.

LODBias

s8 irr::video::SMaterialLayer::LODBias

Bias for the mipmap choosing decision.

This value can make the textures more or less blurry than with the default value of 0. The value (divided by 8.f) is added to the mipmap level chosen initially, and thus takes a smaller mipmap for a region if the value is positive.

Definition at line 215 of file SMaterialLayer.h.

Texture

ITexture* irr::video::SMaterialLayer::Texture

Texture.

Definition at line 185 of file SMaterialLayer.h.

TextureWrapU

u8 irr::video::SMaterialLayer::TextureWrapU

Texture Clamp Mode.

Values are taken from E_TEXTURE_CLAMP.

Definition at line 189 of file SMaterialLayer.h.

TextureWrapV

u8 irr::video::SMaterialLayer::TextureWrapV

Definition at line 190 of file SMaterialLayer.h.

TextureWrapW

u8 irr::video::SMaterialLayer::TextureWrapW

Definition at line 191 of file SMaterialLayer.h.

TrilinearFilter

bool irr::video::SMaterialLayer::TrilinearFilter

Is trilinear filtering enabled? Default: false.

If the trilinear filter flag is enabled, the bilinear filtering flag is ignored.

Definition at line 199 of file SMaterialLayer.h.

---

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

• include/irrlicht/SMaterialLayer.h