EnvironmentMapEffect Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Contains a configurable effect that supports environment mapping.
Inheritance Hierarchy
System.Object
Microsoft.Xna.Framework.Graphics.Effect
Microsoft.Xna.Framework.Graphics.EnvironmentMapEffect
Namespace: Microsoft.Xna.Framework.Graphics
Assembly: Microsoft.Xna.Framework.Graphics.Extensions (in Microsoft.Xna.Framework.Graphics.Extensions.dll)
Syntax
'Declaration
Public Class EnvironmentMapEffect _
Inherits Effect _
Implements IEffectMatrices, IEffectLights, IEffectFog
public class EnvironmentMapEffect : Effect,
IEffectMatrices, IEffectLights, IEffectFog
The EnvironmentMapEffect type exposes the following members.
Constructors
Name | Description | |
---|---|---|
EnvironmentMapEffect | Initializes a new instance of the EnvironmentMapEffect class. |
Top
Properties
Name | Description | |
---|---|---|
Alpha | Gets or sets the material alpha which determines its transparency. Range is between 1 (fully opaque) and 0 (fully transparent). | |
AmbientLightColor | Gets or sets the ambient color for a light, the range of color values is from 0 to 1. | |
CurrentTechnique | Gets or sets the active technique. (Inherited from Effect.) | |
DiffuseColor | Gets or sets the diffuse color for a material, the range of color values is from 0 to 1. | |
DirectionalLight0 | Gets the first directional light. | |
DirectionalLight1 | Gets the second directional light. | |
DirectionalLight2 | Gets the third directional light. | |
EmissiveColor | Gets or sets the emissive color for a material, the range of color values is from 0 to 1. | |
EnvironmentMap | Gets or sets the current environment map texture. | |
EnvironmentMapAmount | Gets or sets the amount of the environment map color (RGB) that will be blended over the base texture. The value ranges from 0 to 1; the default value is 1. | |
EnvironmentMapSpecular | Gets or sets the amount of the environment map alpha value that will be added to the base texture. The value ranges from 0 to 1; the default value is 0. | |
FogColor | Gets or sets the fog color, the range of color values is from 0 to 1. | |
FogEnabled | Gets or sets the fog enable flag. | |
FogEnd | Gets or sets the maximum z value for fog. | |
FogStart | Gets or sets the minimum z value for fog. | |
FresnelFactor | Gets or sets the Fresnel factor used for the environment map blending. | |
IsDisposed | Gets a value that indicates whether the object is disposed. (Inherited from Effect.) | |
Projection | Gets or sets the projection matrix. | |
Techniques | Gets a collection of techniques that are defined for this effect. (Inherited from Effect.) | |
Texture | Gets or sets the current texture. | |
View | Gets or sets the view matrix. | |
World | Gets or sets the world matrix. |
Top
Methods
Name | Description | |
---|---|---|
Dispose() | Immediately releases the unmanaged resources used by this object. (Inherited from Effect.) | |
Dispose(Boolean) | Releases the unmanaged resources used by the Effect and optionally releases the managed resources. (Inherited from Effect.) | |
EnableDefaultLighting | Sets up standard key, fill, and back lighting for an EnvironmentMapEffect. | |
Finalize | Allows this object to attempt to free resources and perform other cleanup operations before garbage collection reclaims the object. (Inherited from Effect.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IEffectLights.LightingEnabled | Enables lighting in an EnvironmentMapEffect. |
Top
Version Information
Silverlight
Supported in: 5
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.