Microsoft.Xna.Framework.Graphics

Class DualTextureEffect

java.lang.Object

Microsoft.Xna.Framework.Graphics.GraphicsResource

Microsoft.Xna.Framework.Graphics.Effect

Microsoft.Xna.Framework.Graphics.DualTextureEffect

All Implemented Interfaces:

IEffectFog, IEffectMatrices, IDisposable

public class DualTextureEffect
extends Effect
implements IEffectMatrices, IEffectFog

Contains a configurable effect that supports two-layer multitexturing.

Author:

Halofreak1990

Field Summary

Fields inherited from class Microsoft.Xna.Framework.Graphics.Effect

CurrentTechnique

Fields inherited from class Microsoft.Xna.Framework.Graphics.GraphicsResource

_parent, Disposing, Name, Tag

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DualTextureEffect(DualTextureEffect cloneSource) Creates a new DualTextureEffect by cloning parameter settings from an existing instance.
	DualTextureEffect(GraphicsDevice device) Creates a new DualTextureEffect with default parameter settings.

Method Summary

Methods

Modifier and Type	Method and Description
Effect	Clone() Creates a clone of the current DualTextureEffect instance.
boolean	FogEnabled()
float	getAlpha() Gets the material alpha which determines its transparency.
Vector3	getDiffuseColor() Gets the diffuse color for a material.
Vector3	getFogColor()
float	getFogEnd()
float	getFogStart()
Matrix	getProjection()
Texture2D	getTexture() Gets the current base texture.
Texture2D	getTexture2() Gets the current overlay texture.
Matrix	getView() Gets the view matrix.
Matrix	getWorld() Gets the world matrix.
protected void	OnApply() Computes derived parameter values immediately before applying the effect.
void	setAlpha(float value) Sets the material alpha which determines its transparency.
void	setDiffuseColor(Vector3 value) Sets the diffuse color for a material, the range of color values is from 0 to 1.
void	setFogColor(Vector3 value)
void	setFogEnabled(boolean value)
void	setFogEnd(float value)
void	setFogStart(float value)
void	setProjection(Matrix value)
void	setTexture(Texture2D value) Sets the current base texture.
void	setTexture2(Texture2D value) Sets the current overlay texture.
void	setView(Matrix value) Sets the view matrix.
void	setWorld(Matrix value) Sets the world matrix.

Methods inherited from class Microsoft.Xna.Framework.Graphics.Effect

Dispose, getParameters, getTechniques

Methods inherited from class Microsoft.Xna.Framework.Graphics.GraphicsResource

Dispose, finalize, getGraphicsDevice, IsDisposed, raise_disposing, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DualTextureEffect

protected DualTextureEffect(DualTextureEffect cloneSource)

Creates a new DualTextureEffect by cloning parameter settings from an existing instance.

Parameters:

cloneSource - The object to clone.

DualTextureEffect

public DualTextureEffect(GraphicsDevice device)

Creates a new DualTextureEffect with default parameter settings.

Parameters:

device - The graphics device.

Method Detail

getAlpha

public float getAlpha()

Gets the material alpha which determines its transparency.

Returns:

The material alpha which determines its transparency.

setAlpha

public void setAlpha(float value)

Sets the material alpha which determines its transparency. Range is between 1 (fully opaque) and 0 (fully transparent).

Parameters:

value - The new alpha value.

getDiffuseColor

public Vector3 getDiffuseColor()

Gets the diffuse color for a material.

Returns:

The diffuse color for a material.

setDiffuseColor

public void setDiffuseColor(Vector3 value)

Sets the diffuse color for a material, the range of color values is from 0 to 1.

Parameters:

value - The new diffuse color.

getFogColor

public Vector3 getFogColor()

Specified by:

getFogColor in interface IEffectFog

setFogColor

public void setFogColor(Vector3 value)

Specified by:

setFogColor in interface IEffectFog

FogEnabled

public boolean FogEnabled()

Specified by:

FogEnabled in interface IEffectFog

setFogEnabled

public void setFogEnabled(boolean value)

Specified by:

setFogEnabled in interface IEffectFog

getFogEnd

public float getFogEnd()

Specified by:

getFogEnd in interface IEffectFog

setFogEnd

public void setFogEnd(float value)

Specified by:

setFogEnd in interface IEffectFog

getFogStart

public float getFogStart()

Specified by:

getFogStart in interface IEffectFog

setFogStart

public void setFogStart(float value)

Specified by:

setFogStart in interface IEffectFog

getProjection

public Matrix getProjection()

Specified by:

getProjection in interface IEffectMatrices

setProjection

public void setProjection(Matrix value)

Specified by:

setProjection in interface IEffectMatrices

getTexture

public Texture2D getTexture()

Gets the current base texture.

Returns:

The current base texture.

setTexture

public void setTexture(Texture2D value)

Sets the current base texture.

Parameters:

value - The new base texture.

getTexture2

public Texture2D getTexture2()

Gets the current overlay texture.

Returns:

The current base texture.

setTexture2

public void setTexture2(Texture2D value)

Sets the current overlay texture.

Parameters:

value - The new overlay texture.

getView

public Matrix getView()

Gets the view matrix.

Specified by:

getView in interface IEffectMatrices

Returns:

The view matrix.

setView

public void setView(Matrix value)

Sets the view matrix.

Specified by:

setView in interface IEffectMatrices

Parameters:

value - The new view matrix.

getWorld

public Matrix getWorld()

Gets the world matrix.

Specified by:

getWorld in interface IEffectMatrices

Returns:

The world matrix.

setWorld

public void setWorld(Matrix value)

Sets the world matrix.

Specified by:

setWorld in interface IEffectMatrices

Parameters:

value - The new world matrix.

OnApply

protected void OnApply()

Computes derived parameter values immediately before applying the effect.

Overrides:

OnApply in class Effect

Clone

public Effect Clone()

Creates a clone of the current DualTextureEffect instance.

Overrides:

Clone in class Effect