RenderToEnvironmentMap Class

Language:

Generalizes the process of rendering to environment maps. An environment map is used to texture-map scene geometry to provide a more sophisticated scene without using complex geometry. This class supports the creation of surfaces for the following kinds of geometry: cube, half sphere or hemispheric, parabolic, and sphere.

Definition

Visual Basic NotInheritable Public Class RenderToEnvironmentMap
Inherits MarshalByRefObject
Implements IDisposable

C# public sealed class RenderToEnvironmentMap : MarshalByRefObject, IDisposable

C++ public ref class RenderToEnvironmentMap sealed : MarshalByRefObject, IDisposable

JScript public final class RenderToEnvironmentMap extends MarshalByRefObject implements IDisposable

Visual Basic	NotInheritable Public Class RenderToEnvironmentMap Inherits MarshalByRefObject Implements IDisposable
C#	public sealed class RenderToEnvironmentMap : MarshalByRefObject, IDisposable
C++	public ref class RenderToEnvironmentMap sealed : MarshalByRefObject, IDisposable
JScript	public final class RenderToEnvironmentMap extends MarshalByRefObject implements IDisposable

Members Table

The following table lists the members exposed by the object. Click a tab on the left to choose the type of member you want to view.

Events

Event Description

Disposing Occurs when the Dispose method is called or when the RenderToEnvironmentMap object is finalized and collected by the garbage collector of the .NET common language runtime.

Lost Occurs when an object is lost, normally immediately prior to a device reset.

Reset Occurs after the RenderToEnvironmentMap.OnResetDevice method is called or after the Device is reset.

Methods

Method Description

BeginCube Initiates the rendering of a cubic environment map.

BeginHemisphere Initiates the rendering of a hemisphere environment map.

BeginParabolic Initiates the rendering of a parabolic environment map.

BeginSphere Initiates the rendering of a spherical environment map.

Dispose Immediately releases the unmanaged resources used by the RenderToEnvironmentMap object.

End Ends a scene for an environmental map.

Equals Returns a value that indicates whether the current instance is equal to a specified object.

Face Initiates the drawing of each face of an environment map.

Finalize Allows the RenderToEnvironmentMap object to free resources before it is destroyed by the garbage collector.

GetHashCode Returns the hash code for the current instance.

GetObjectByValue This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code.

OnLostDevice Releases all references to video memory resources and deletes all state blocks.

OnResetDevice Should be called after a device is reset and before any other methods are called, if Device.IsUsingEventHandlers is set to false.

op_Equality Compares the current instance of a class to another instance to determine whether they are the same.

op_Inequality Compares the current instance of a class to another instance to determine whether they are different.

raise_Disposing Raises the Microsoft.DirectX.Direct3D.RenderToEnvironmentMap.Disposing event when called from within a derived class.

raise_Lost Raises a RenderToEnvironmentMap.Lost event when called from within a derived class.

raise_Reset Raises a RenderToEnvironmentMap.Reset event when called from within a derived class.

RenderToEnvironmentMap Initializes a new instance of the RenderToEnvironmentMap class.

UpdateUnmanagedPointer Updates the unmanaged pointer for this RenderToEnvironmentMap object. This method supports the Microsoft .NET Framework infrastructure and is not intended to be used directly in your code.

Properties

Property Description

Description Retrieves the description of the render surface.

Device Retrieves the Device associated with the environment map.

Disposed Gets a value that indicates whether the object is disposed.

UnmanagedComPointer Returns the unmanaged Component Object Model (COM) ID3DXRenderToEnvMap interface pointer.

Event	Description
Disposing	Occurs when the Dispose method is called or when the RenderToEnvironmentMap object is finalized and collected by the garbage collector of the .NET common language runtime.
Lost	Occurs when an object is lost, normally immediately prior to a device reset.
Reset	Occurs after the RenderToEnvironmentMap.OnResetDevice method is called or after the Device is reset.

Method	Description
BeginCube	Initiates the rendering of a cubic environment map.
BeginHemisphere	Initiates the rendering of a hemisphere environment map.
BeginParabolic	Initiates the rendering of a parabolic environment map.
BeginSphere	Initiates the rendering of a spherical environment map.
Dispose	Immediately releases the unmanaged resources used by the RenderToEnvironmentMap object.
End	Ends a scene for an environmental map.
Equals	Returns a value that indicates whether the current instance is equal to a specified object.
Face	Initiates the drawing of each face of an environment map.
Finalize	Allows the RenderToEnvironmentMap object to free resources before it is destroyed by the garbage collector.
GetHashCode	Returns the hash code for the current instance.
GetObjectByValue	This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code.
OnLostDevice	Releases all references to video memory resources and deletes all state blocks.
OnResetDevice	Should be called after a device is reset and before any other methods are called, if Device.IsUsingEventHandlers is set to false.
op_Equality	Compares the current instance of a class to another instance to determine whether they are the same.
op_Inequality	Compares the current instance of a class to another instance to determine whether they are different.
raise_Disposing	Raises the Microsoft.DirectX.Direct3D.RenderToEnvironmentMap.Disposing event when called from within a derived class.
raise_Lost	Raises a RenderToEnvironmentMap.Lost event when called from within a derived class.
raise_Reset	Raises a RenderToEnvironmentMap.Reset event when called from within a derived class.
RenderToEnvironmentMap	Initializes a new instance of the RenderToEnvironmentMap class.
UpdateUnmanagedPointer	Updates the unmanaged pointer for this RenderToEnvironmentMap object. This method supports the Microsoft .NET Framework infrastructure and is not intended to be used directly in your code.

Property	Description
Description	Retrieves the description of the render surface.
Device	Retrieves the Device associated with the environment map.
Disposed	Gets a value that indicates whether the object is disposed.
UnmanagedComPointer	Returns the unmanaged Component Object Model (COM) ID3DXRenderToEnvMap interface pointer.

Inheritance Hierarchy

Object
MarshalByRefObject
RenderToEnvironmentMap

Class Information

Namespace Microsoft.DirectX.Direct3D

Assembly Microsoft.DirectX.Direct3DX (microsoft.directx.direct3dx.dll)

Strong Name Microsoft.DirectX.Direct3DX, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Namespace	Microsoft.DirectX.Direct3D
Assembly	Microsoft.DirectX.Direct3DX (microsoft.directx.direct3dx.dll)
Strong Name	Microsoft.DirectX.Direct3DX, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center