Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET
Class representing the state of a single texture unit during a Pass of a Technique, of a Material.

Namespace: Visual3D.Graphics3D
Assembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

      
 C#  Visual Basic 
public class TextureReference
Public Class TextureReference

Members

               
 All Members  Constructors   Fields   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
TextureReference(OgreRenderPass)
Default constructor.
TextureReference(OgreRenderPass, String)
Name based constructor.
TextureReference(OgreRenderPass, String, Int32)
Constructor.
AddEffect(TextureEffect)
Generic method for setting up texture effects.
AlphaBlendMode
Gets a structure that describes the layer blending mode parameters.
Blank
Gets/Sets whether this layer is blank or not.
BorderColor
Gets/sets color used for Border texture addressing mode. Default is Transparent.
Clone(OgreRenderPass)
Used to clone a texture layer. Mainly used during a call to Clone on a Material or Pass.
ColorBlendFallbackDest
Gets/Sets the multipass fallback for color blending operation destination factor.
ColorBlendFallbackSource
Gets/Sets the multipass fallback for color blending operation source factor.
ColorBlendMode
Gets a structure that describes the layer blending mode parameters.
ColorOperation
CopyTo(TextureReference)
Used to clone a texture layer. Mainly used during a call to Clone on a Material.
CurrentFrame
Gets/Sets the active frame in an animated or multi-image texture.
EnvironmentMapEnabled
GetEffect(Int32)
Gets the texture effect at the specified index.
GetEnvironmentMap()()()()
GetFrameTextureName(Int32)
Gets the name of the texture associated with a frame.
GetTextureFiltering()()()()
Complementary method for SetTextureFilteringm.
GetTextureFiltering(FilterType)
Gets the texture filtering for the given type.
HasViewRelativeTexCoordGen
Returns true if this texture unit requires an updated view matrix to allow for proper texture matrix generation.
Is3D
Returns true if this texture layer uses a composite 3D cubic texture.
IsCubic
Returns true if this texture unit is either a series of 6 2D textures, each in it's own frame, or is a full 3D cube map. You can tell which by checking TextureType.
IsLoaded
Returns true if the resource for this texture layer have been loaded.
IsNotFound
Returns true if the resource for this texture layer is not found in the library.
Load()()()()
Internal method for loading this texture stage as part of Material.Load.
MaxAnimationFrames
Maximum amount of animation frames allowed.
NotifyNeedsRecompile()()()()
Notifies the parent that it needs recompilation.
NumEffects
Gets the number of effects currently tied to this texture stage.
NumFrames
Gets the number of frames for a texture.
Parent
Gets a reference to the Pass that owns this TextureUnitState.
RemoveAllEffects()()()()
Removes all effects from this texture stage.
RemoveEffect(TextureEffect)
Removes the specified effect from the list of effects being applied during this texture stage.
RotationSpeed
RotationStatic
ScaleU
ScaleV
SetAlphaOperation(TextureOperation)
Overloaded method.
SetAlphaOperation(TextureOperation, LayerBlendSource, LayerBlendSource, Single, Single, Single)
Sets the alpha operation to be applied to this texture.
SetAnimatedTextureName(String, Int32, Single)
Sets the names of the texture images for an animated texture.
SetAnimatedTextureName(array<String>[]()[][], Int32, Single)
Sets the names of the texture images for an animated texture.
SetColorOperation(LayerBlendOperation)
Determines how this texture layer is combined with the one below it (or the diffuse color of the geometry if this is layer 0).
SetColorOperationEx(TextureOperation)
Overloaded method.
SetColorOperationEx(TextureOperation, LayerBlendSource, LayerBlendSource)
Overloaded method.
SetColorOperationEx(TextureOperation, LayerBlendSource, LayerBlendSource, VColor)
Overloaded method.
SetColorOperationEx(TextureOperation, LayerBlendSource, LayerBlendSource, VColor, VColor, Single)
For setting advanced blending options.
SetColorOpMultipassFallback(Blend, Blend)
Sets the multipass fallback operation for this layer, if you used TextureUnitState.SetColorOperationEx and not enough multitexturing hardware is available.
SetCubicTexture(String, Boolean)
SetCubicTexture(array<String>[]()[][], Boolean)
SetEnvironmentMap(Boolean)
Overloaded method.
SetEnvironmentMap(Boolean, EnvironmentMapType)
Turns on/off texture coordinate effect that makes this layer an environment map.
SetRotateAnimation(Single)
Sets up an animated texture rotation for this layer.
SetScrollAnimation(Single, Single)
Sets up an animated scroll for the texture layer.
SetTextureFiltering(TextureFiltering)
Set the texture filtering for this unit, using the simplified interface.
SetTextureFiltering(FilterType, FilterOptions)
Set a single filtering option on this texture unit.
SetTextureFiltering(FilterOptions, FilterOptions, FilterOptions)
Set a the detailed filtering options on this texture unit.
SetTextureName(String)
Sets this texture layer to use a single texture, given the name of the texture to use on this layer.
SetTextureName(String, TextureType)
Sets this texture layer to use a single texture, given the name of the texture to use on this layer.
SetTextureRotate(Single)
Sets the counter-clockwise rotation factor applied to texture coordinates.
SetTextureScale(Single, Single)
Sets the scaling factor of the texture.
SetTextureScaleU(Single)
Same as in SetTextureScale, but sets only U value.
SetTextureScaleV(Single)
Same as in SetTextureScale, but sets only V value.
SetTextureScroll(Single, Single)
Sets the translation offset of the texture, ie scrolls the texture.
SetTextureScrollU(Single)
Same as in SetTextureScroll, but sets only U value.
SetTextureScrollV(Single)
Same as in SetTextureScroll, but sets only V value.
SetTransformAnimation(TextureTransform, WaveformType, Single, Single, Single, Single)
Sets up a general time-relative texture modification effect.
Texture
Gets/sets direct reference to the texture.
TextureAddressing
Gets/Sets the texture addressing mode, i.e. what happens at uv values above 1.0.
TextureAnimU
TextureAnimV
TextureAnisotropy
Gets/Sets the anisotropy level to be used for this texture stage.
TextureCoordSet
Gets/Sets the texture coordinate set to be used by this texture layer.
TextureHandle
TextureMatrix
TextureName
Gets/Sets the name of the texture for this texture pass.
TextureScrollU
TextureScrollV
TextureType
Gets the type of texture this unit has.
Unload()()()()
Internal method for unloading this object as part of Material.Unload.

Remarks

Texture units are pipelines for retrieving texture data for rendering onto your objects in the world. Using them is common to both the fixed-function and the programmable (vertex and fragment program) pipeline, but some of the settings will only have an effect in the fixed-function pipeline (for example, setting a texture rotation will have no effect if you use the programmable pipeline, because this is overridden by the fragment program). The effect of each setting as regards the 2 pipelines is commented in each setting.

When I use the term 'fixed-function pipeline' I mean traditional rendering where you do not use vertex or fragment programs (shaders). Programmable pipeline means that for this pass you are using vertex or fragment programs.

Inheritance Hierarchy

System..::..Object
  Visual3D.Graphics3D..::..TextureReference

See Also