Irrlicht 3D Engine
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...
 
core::matrix4getTextureMatrix ()
 Gets the texture transformation matrix. More...
 
const core::matrix4getTextureMatrix () const
 Gets the immutable texture transformation matrix. More...
 
bool operator!= (const SMaterialLayer &b) const
 Inequality operator. More...
 
SMaterialLayeroperator= (const SMaterialLayer &other)
 Assignment operator. More...
 
bool operator== (const SMaterialLayer &b) const
 Equality operator. More...
 
void setTextureMatrix (const core::matrix4 &mat)
 Sets the texture transformation matrix to mat. More...
 

Public Attributes

u8 AnisotropicFilter
 Is anisotropic filtering enabled? Default: 0, disabled. More...
 
bool BilinearFilter:1
 Is bilinear filtering enabled? Default: true. More...
 
s8 LODBias
 Bias for the mipmap choosing decision. More...
 
ITextureTexture
 Texture. More...
 
u8 TextureWrapU:4
 Texture Clamp Mode. More...
 
u8 TextureWrapV:4
 
u8 TextureWrapW:4
 
bool TrilinearFilter:1
 Is trilinear filtering enabled? Default: false. 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.

◆ SMaterialLayer() [2/2]

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

Copy constructor.

Parameters
otherMaterial layer to copy from.

Definition at line 60 of file SMaterialLayer.h.

◆ ~SMaterialLayer()

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

Destructor.

Definition at line 68 of file SMaterialLayer.h.

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.

References irr::core::IdentityMatrix.

Referenced by irr::video::SMaterial::getTextureMatrix().

◆ 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.

References irr::core::IdentityMatrix.

◆ operator!=()

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

Inequality operator.

Parameters
bLayer to compare to.
Returns
True if layers are different, else false.

Definition at line 159 of file SMaterialLayer.h.

References AnisotropicFilter, BilinearFilter, LODBias, Texture, TextureWrapU, TextureWrapV, TextureWrapW, and TrilinearFilter.

◆ operator=()

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

Assignment operator.

Parameters
otherMaterial layer to copy from.
Returns
This material layer, updated.

Definition at line 80 of file SMaterialLayer.h.

References AnisotropicFilter, BilinearFilter, LODBias, Texture, TextureWrapU, TextureWrapV, TextureWrapW, and TrilinearFilter.

◆ operator==()

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

Equality operator.

Parameters
bLayer to compare to.
Returns
True if layers are equal, else false.

Definition at line 181 of file SMaterialLayer.h.

◆ 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
matNew texture matrix for this layer.

Definition at line 145 of file SMaterialLayer.h.

Referenced by irr::video::SMaterial::setTextureMatrix().

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.

Referenced by irr::video::SOverrideMaterial::apply(), irr::video::SMaterial::getFlag(), operator!=(), and operator=().

◆ BilinearFilter

bool irr::video::SMaterialLayer::BilinearFilter

Is bilinear filtering enabled? Default: true.

Definition at line 194 of file SMaterialLayer.h.

Referenced by irr::video::SOverrideMaterial::apply(), irr::video::SMaterial::getFlag(), operator!=(), and operator=().

◆ 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.

Referenced by operator!=(), and operator=().

◆ Texture

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

◆ TextureWrapU

u8 irr::video::SMaterialLayer::TextureWrapU

Texture Clamp Mode.

Values are taken from E_TEXTURE_CLAMP.

Definition at line 189 of file SMaterialLayer.h.

Referenced by irr::video::SOverrideMaterial::apply(), irr::video::SMaterial::getFlag(), operator!=(), operator=(), and irr::video::SMaterial::setFlag().

◆ TextureWrapV

u8 irr::video::SMaterialLayer::TextureWrapV

◆ TextureWrapW

u8 irr::video::SMaterialLayer::TextureWrapW

◆ 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.

Referenced by irr::video::SOverrideMaterial::apply(), irr::video::SMaterial::getFlag(), operator!=(), and operator=().


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