Microsoft.Xna.Framework.Graphics

Class Effect

java.lang.Object

Microsoft.Xna.Framework.Graphics.GraphicsResource

Microsoft.Xna.Framework.Graphics.Effect

All Implemented Interfaces:

IDisposable

Direct Known Subclasses:

DualTextureEffect, EffectMaterial

public class Effect
extends GraphicsResource

Used to set and query effects, and to choose techniques.

Author:

Halofreak1990

Field Summary

Fields

Modifier and Type	Field and Description
EffectTechnique	CurrentTechnique Gets or sets the active technique.

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

_parent, Disposing, Name, Tag

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Effect(Effect cloneSource) Creates an instance of this object.
	Effect(GraphicsDevice graphicsDevice, byte[] byteCode) Creates an instance of this object.

Method Summary

Methods

Modifier and Type	Method and Description
Effect	Clone() Copies data from an existing object to this object.
protected void	Dispose(boolean disposing) Releases the unmanaged resources used by the Effect and optionally releases the managed resources.
EffectParameterCollection	getParameters() Gets a collection of parameters used for this effect.
EffectTechniqueCollection	getTechniques() Gets a collection of techniques that are defined for this effect.
protected void	OnApply() Applies the effect state just prior to rendering the effect.

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

Field Detail

CurrentTechnique

public EffectTechnique CurrentTechnique

Gets or sets the active technique.

Constructor Detail

Effect

protected Effect(Effect cloneSource)

Creates an instance of this object.

Parameters:

cloneSource - An object to copy.

Effect

public Effect(GraphicsDevice graphicsDevice,
      byte[] byteCode)

Creates an instance of this object.

Parameters:

graphicsDevice - The device.

byteCode - The effect code.

Method Detail

getParameters

public EffectParameterCollection getParameters()

Gets a collection of parameters used for this effect.

getTechniques

public EffectTechniqueCollection getTechniques()

Gets a collection of techniques that are defined for this effect.

Dispose

protected void Dispose(boolean disposing)

Releases the unmanaged resources used by the Effect and optionally releases the managed resources.

Overrides:

Dispose in class GraphicsResource

OnApply

protected void OnApply()

Applies the effect state just prior to rendering the effect.

Clone

public Effect Clone()

Copies data from an existing object to this object.