28 #ifndef __TextureUnitState_H__
29 #define __TextureUnitState_H__
479 BT_TESSELATION_HULL = 3,
481 BT_TESSELATION_DOMAIN = 4,
494 CONTENT_COMPOSITOR = 2
819 Real manualBlend = 0.0);
908 Real manualBlend = 0.0);
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Class representing colour.
static const ColourValue White
A frustum represents a pyramid, capped at the near and far end which is used to represent either a vi...
Class which manages blending of both colour and alpha components.
Class encapsulating a standard 4x4 homogeneous matrix.
Class defining a single pass of a Technique (of a Material), i.e.
Wrapper class which indicates a given angle value is in Radians.
Defines the functionality of a 3D API.
Class representing the state of a single texture unit during a Pass of a Technique,...
void setCompositorReference(const String &compositorName, const String &textureName, size_t mrtIndex=0)
Set the compositor reference for this texture unit state.
unsigned int mCurrentFrame
The current animation frame.
const String & getFrameTextureName(unsigned int frameNumber) const
Gets the name of the texture associated with a frame number.
void setCurrentFrame(unsigned int frameNumber)
Changes the active frame in an animated or multi-image texture.
bool isHardwareGammaEnabled() const
Gets whether this texture will be set up so that on sampling it, hardware gamma correction is applied...
void setDesiredFormat(PixelFormat desiredFormat)
Sets the desired pixel format when load the texture.
void setHardwareGammaEnabled(bool enabled)
Sets whether this texture will be set up so that on sampling it, hardware gamma correction is applied...
void setBindingType(BindingType bt)
Sets the type of unit these texture settings should be bound to.
void setBlank(void)
Sets this texture layer to be blank.
ColourValue mBorderColour
unsigned int mTextureCoordSetIndex
Request number of mipmaps.
void setTextureUScale(Real value)
As setTextureScale, but sets only U value.
vector< TexturePtr >::type mFramePtrs
void setIsAlpha(bool isAlpha)
Sets whether this texture is requested to be loaded as alpha if single channel.
void _load(void)
Internal method for loading this object as part of Material::load.
ContentType getContentType(void) const
Get the type of content this TextureUnitState references.
multimap< TextureEffectType, TextureEffect >::type EffectMap
Texture effects in a multimap paired array.
bool hasViewRelativeTextureCoordinateGeneration(void) const
Returns whether this unit has texture coordinate generation that depends on the camera.
BindingType mBindingType
Binding type (fragment or vertex pipeline).
void _unload(void)
Internal method for unloading this object as part of Material::unload.
void setColourOpMultipassFallback(const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor)
Sets the multipass fallback operation for this layer, if you used TextureUnitState::setColourOperatio...
bool applyTextureAliases(const AliasTextureNamePairList &aliasList, const bool apply=true)
Applies texture names to Texture Unit State with matching texture name aliases.
~TextureUnitState()
Default destructor.
void setTextureAddressingMode(TextureAddressingMode u, TextureAddressingMode v, TextureAddressingMode w)
Sets the texture addressing mode, i.e.
TextureCubeFace
Enum identifying the frame indexes for faces of a cube map (not the composite 3D type.
bool getIsAlpha(void) const
Gets whether this texture is requested to be loaded as alpha if single channel.
Real getAnimationDuration(void) const
Get the animated-texture animation duration.
size_t calculateSize(void) const
CompareFunction getTextureCompareFunction() const
void removeAllEffects(void)
Removes all effects applied to this texture layer.
const LayerBlendModeEx & getColourBlendMode(void) const
Get multitexturing colour blending mode.
unsigned int getNumFrames(void) const
Gets the number of frames for a texture.
void setTextureFiltering(TextureFilterOptions filterType)
Set the texture filtering for this unit, using the simplified interface.
TextureUnitState(Pass *parent)
Default constructor.
void setEnvironmentMap(bool enable, EnvMapType envMapType=ENV_CURVED)
Turns on/off texture coordinate effect that makes this layer an environment map.
SceneBlendFactor mColourBlendFallbackDest
void setTextureScroll(Real u, Real v)
Sets the translation offset of the texture, ie scrolls the texture.
ContentType
Enum identifying the type of content this texture unit contains.
void retryTextureLoad()
Tells the unit to retry loading the texture if it had failed to load.
bool isLoaded(void) const
Is this loaded?
const Radian & getTextureRotate(void) const
Get texture rotation effects angle value.
void setTextureFiltering(FilterType ftype, FilterOptions opts)
Set a single filtering option on this texture unit.
const String & getTextureNameAlias(void) const
Gets the Texture Name Alias of the Texture Unit.
LayerBlendModeEx mAlphaBlendMode
BindingType getBindingType(void) const
Gets the type of unit these texture settings should be bound to.
const String & getName(void) const
Get the name of the Texture Unit State.
Real getTextureUScroll(void) const
Get texture uscroll value.
String mTextureNameAlias
Optional alias for texture frames.
void recalcTextureMatrix(void) const
Internal method for calculating texture matrix.
BindingType
The type of unit to bind the texture settings to.
void setTextureCompareFunction(CompareFunction function)
void setScrollAnimation(Real uSpeed, Real vSpeed)
Sets up an animated scroll for the texture layer.
const Matrix4 & getTextureTransform(void) const
Gets the current texture transformation matrix.
void setTextureBorderColour(const ColourValue &colour)
Sets the texture border colour.
TextureUnitState(Pass *parent, const TextureUnitState &oth)
TextureAddressingMode
Texture addressing modes - default is TAM_WRAP.
@ TAM_CLAMP
Texture clamps at 1.0.
@ TAM_MIRROR
Texture mirrors (flips) at joins over 1.0.
@ TAM_BORDER
Texture coordinates outside the range [0.0, 1.0] are set to the border colour.
@ TAM_WRAP
Texture wraps at values over 1.0.
PixelFormat getDesiredFormat(void) const
Gets the desired pixel format when load the texture.
size_t getReferencedMRTIndex() const
Gets the MRT index of the texture in the compositor that this texture references.
unsigned int getTextureCoordSet(void) const
Gets the index of the set of texture co-ords this layer uses.
bool isBlank(void) const
Determines if this texture layer is currently blank.
Real getTextureVScroll(void) const
Get texture vscroll value.
void setAnimatedTextureName(const String &name, unsigned int numFrames, Real duration=0)
Sets the names of the texture images for an animated texture.
float mMipmapBias
Mipmap bias (always float, not Real).
SceneBlendFactor getColourBlendFallbackSrc(void) const
Get the multipass fallback for colour blending operation source factor.
PixelFormat mDesiredFormat
void setProjectiveTexturing(bool enabled, const Frustum *projectionSettings=0)
Enables or disables projective texturing on this texture unit.
String mName
Optional name for the TUS.
CompareFunction mCompareFunc
String mCompositorRefTexName
float getTextureMipmapBias(void) const
Gets the bias value applied to the mipmap calculation.
void setTexture(const TexturePtr &texPtr)
Sets this texture layer to use a single texture, given the pointer to the texture to use on this laye...
const String & getReferencedTextureName() const
Gets the name of the texture in the compositor that this texture references.
void setColourOperationEx(LayerBlendOperationEx op, LayerBlendSource source1=LBS_TEXTURE, LayerBlendSource source2=LBS_CURRENT, const ColourValue &arg1=ColourValue::White, const ColourValue &arg2=ColourValue::White, Real manualBlend=0.0)
Setting advanced blending options.
void _setTexturePtr(const TexturePtr &texptr, size_t frame)
Set the texture pointer for a given frame (internal use only!).
void addEffect(TextureEffect &effect)
Generic method for setting up texture effects.
unsigned int getCurrentFrame(void) const
Gets the active frame in an animated or multi-image texture layer.
TextureType mTextureType
Is this a series of 6 2D textures to make up a cube?
void _notifyParent(Pass *parent)
Notify this object that its parent has changed.
bool is3D(void) const
Returns true if this texture layer uses a composite 3D cubic texture.
TextureType getTextureType(void) const
Returns the type of this texture.
void setTextureCoordSet(unsigned int set)
Sets the index of the set of texture co-ords this layer uses.
TextureEffectType
Definition of the broad types of texture effect you can apply to a texture unit.
@ ET_ENVIRONMENT_MAP
Generate all texture coords based on angle between camera and vertex.
@ ET_VSCROLL
Constant u/v scrolling effect.
@ ET_ROTATE
Constant rotation.
@ ET_USCROLL
Constant u scrolling effect.
@ ET_UVSCROLL
Constant u/v scrolling effect.
@ ET_PROJECTIVE_TEXTURE
Generate texture coords based on a frustum.
void _unprepare(void)
Internal method for undoing the preparation this object as part of Material::unprepare.
void setAnimatedTextureName(const String *const names, unsigned int numFrames, Real duration=0)
Sets the names of the texture images for an animated texture.
EnvMapType
Enumeration to specify type of envmap.
@ ENV_REFLECTION
Envmap intended to supply reflection vectors for cube mapping.
@ ENV_PLANAR
Envmap based on vector from camera to vertex position, good for planar geometry.
@ ENV_CURVED
Envmap based on dot of vector from camera to vertex and vertex normal, good for curves.
void setRotateAnimation(Real speed)
Sets up an animated texture rotation for this layer.
const LayerBlendModeEx & getAlphaBlendMode(void) const
Get multitexturing alpha blending mode.
FilterOptions mMipFilter
Texture filtering - mipmapping.
void _notifyNeedsRecompile(void)
Tells the class that it needs recompilation.
void deleteFrameTextureName(const size_t frameNumber)
Deletes a specific texture frame.
UVWAddressingMode mAddressMode
void createEffectController(TextureEffect &effect)
Internal method for creating texture effect controller.
void setTextureVScroll(Real value)
As setTextureScroll, but sets only V value.
void addFrameTextureName(const String &name)
Add a Texture name to the end of the frame container.
bool isTextureLoadFailing() const
Tests if the texture associated with this unit has failed to load.
const EffectMap & getEffects(void) const
Get texture effects in a multimap paired array.
Pass * getParent(void) const
Gets the parent Pass object.
void setTextureUScroll(Real value)
As setTextureScroll, but sets only U value.
void setTextureAddressingMode(const UVWAddressingMode &uvw)
Sets the texture addressing mode, i.e.
unsigned int mMaxAniso
Texture anisotropy.
Real getGamma() const
Returns the gamma adjustment factor applied to this texture on loading.
void setTextureRotate(const Radian &angle)
Sets the anticlockwise rotation factor applied to texture coordinates.
TextureTransformType
Useful enumeration when dealing with procedural transforms.
const ColourValue & getTextureBorderColour(void) const
Sets the texture border colour.
void removeEffect(const TextureEffectType type)
Removes a single effect applied to this texture layer.
FilterOptions mMinFilter
Texture filtering - minification.
TextureUnitState(Pass *parent, const String &texName, unsigned int texCoordSet=0)
Name-based constructor.
void _prepare(void)
Internal method for preparing this object for load, as part of Material::prepare.
void setGamma(Real gamma)
Sets the gamma adjustment factor applied to this texture on loading the data.
const TexturePtr & _getTexturePtr(void) const
Get the texture pointer for the current frame.
void setCubicTexture(const TexturePtr *const texPtrs, bool forUVW=false)
Sets this texture layer to use a combination of 6 texture maps, each one relating to a face of a cube...
void setTextureName(const String &name, TextureType ttype=TEX_TYPE_2D)
Sets this texture layer to use a single texture, given the name of the texture to use on this layer.
void setTextureCompareEnabled(bool enabled)
void setColourOperation(const LayerBlendOperation op)
Determines how this texture layer is combined with the one below it (or the diffuse colour of the geo...
void setTextureScale(Real uScale, Real vScale)
Sets the scaling factor applied to texture coordinates.
Controller< Real > * _getAnimController() const
Gets the animation controller (as created because of setAnimatedTexture) if it exists.
Controller< Real > * mAnimController
FilterOptions mMagFilter
Texture filtering - magnification.
size_t mCompositorRefMrtIndex
The index of the referenced texture if referencing an MRT in a compositor.
ContentType mContentType
Content type of texture (normal loaded texture, auto-texture).
SceneBlendFactor mColourBlendFallbackSrc
void createAnimController(void)
Internal method for creating animation controller.
std::pair< size_t, size_t > getTextureDimensions(unsigned int frame=0) const
Returns the width and height of the texture in the given frame.
SceneBlendFactor getColourBlendFallbackDest(void) const
Get the multipass fallback for colour blending operation destination factor.
Real getTextureUScale(void) const
Get texture uscale value.
Real getTextureVScale(void) const
Get texture vscale value.
void _setTexturePtr(const TexturePtr &texptr)
Set the texture pointer for the current frame (internal use only!).
void setName(const String &name)
Set the name of the Texture Unit State.
void setTextureAnisotropy(unsigned int maxAniso)
Sets the anisotropy level to be used for this texture level.
String mCompositorRefName
The data that references the compositor.
bool getTextureCompareEnabled() const
int getNumMipmaps(void) const
Gets how many mipmaps have been requested for the texture.
void setTextureAddressingMode(TextureAddressingMode tam)
Sets the texture addressing mode, i.e.
void setTextureTransform(const Matrix4 &xform)
Sets a matrix used to transform any texture coordinates on this layer.
void setTextureNameAlias(const String &name)
Set the alias name used for texture frame names.
void setNumMipmaps(int numMipmaps)
Sets how many mipmaps have been requested for the texture.
vector< String >::type mFrames
LayerBlendModeEx mColourBlendMode
void setTextureMipmapBias(float bias)
Sets the bias value applied to the mipmap calculation.
FilterOptions getTextureFiltering(FilterType ftpye) const
Get the texture filtering for the given type.
Real mAnimDuration
Duration of animation in seconds.
const String & getTextureName(void) const
Get the name of current texture image for this layer.
const UVWAddressingMode & getTextureAddressingMode(void) const
Gets the texture addressing mode for a given coordinate, i.e.
const TexturePtr & _getTexturePtr(size_t frame) const
Get the texture pointer for a given frame.
void setContentType(ContentType ct)
Set the type of content this TextureUnitState references.
unsigned int getTextureAnisotropy() const
Get this layer texture anisotropy level.
void setCubicTextureName(const String *const names, bool forUVW=false)
Sets this texture layer to use a combination of 6 texture maps, each one relating to a face of a cube...
void setAlphaOperation(LayerBlendOperationEx op, LayerBlendSource source1=LBS_TEXTURE, LayerBlendSource source2=LBS_CURRENT, Real arg1=1.0, Real arg2=1.0, Real manualBlend=0.0)
Sets the alpha operation to be applied to this texture.
void setCubicTextureName(const String &name, bool forUVW=false)
Sets this texture layer to use a combination of 6 texture maps, each one relating to a face of a cube...
void ensureLoaded(size_t frame) const
Internal method for ensuring the texture for a given frame is loaded.
void setTransformAnimation(const TextureTransformType ttype, const WaveformType waveType, Real base=0, Real frequency=1, Real phase=0, Real amplitude=1)
Sets up a general time-relative texture modification effect.
void setTextureVScale(Real value)
As setTextureScale, but sets only V value.
void ensurePrepared(size_t frame) const
Internal method for ensuring the texture for a given frame is prepared.
const String & getReferencedCompositorName() const
Gets the name of the compositor that this texture referneces.
void setTextureFiltering(FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
Set a the detailed filtering options on this texture unit.
bool isCubic(void) const
Returns true if this texture unit is either a series of 6 2D textures, each in it's own frame,...
void setFrameTextureName(const String &name, unsigned int frameNumber)
Sets the name of the texture associated with a frame.
CompareFunction
Comparison functions used for the depth/stencil buffer operations and others.
FilterOptions
Filtering options for textures / mipmaps.
map< String, String >::type AliasTextureNamePairList
Alias / Texture name pair (first = alias, second = texture name)
TextureFilterOptions
High-level filtering options providing shortcuts to settings the minification, magnification and mip ...
WaveformType
Enumerates the wave types usable with the Ogre engine.
PixelFormat
The pixel format used for images, textures, and render surfaces.
LayerBlendOperationEx
Expert list of valid texture blending operations, for use with TextureUnitState::setColourOperationEx...
SceneBlendFactor
Blending factors for manually blending objects with the scene.
LayerBlendOperation
List of valid texture blending operations, for use with TextureUnitState::setColourOperation.
LayerBlendSource
List of valid sources of values for blending operations used in TextureUnitState::setColourOperation ...
@ LBS_CURRENT
the colour as built up from previous stages
@ LBS_TEXTURE
the colour derived from the texture assigned to this layer
TextureType
Enum identifying the texture type.
@ TEX_TYPE_2D
2D texture, used in combination with 2D texture coordinates (default)
float Real
Software floating point type.
Internal structure defining a texture effect.
Controller< Real > * controller
Texture addressing mode for each texture coordinate.