RenderToSurface Class

Language:

Generalizes the process of rendering to surfaces. Surfaces can be used in a variety of ways; for example, as render targets, or for off-screen rendering and rendering to textures.

Definition

Visual Basic NotInheritable Public Class RenderToSurface
Inherits MarshalByRefObject
Implements IDisposable

C# public sealed class RenderToSurface : MarshalByRefObject, IDisposable

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

JScript public final class RenderToSurface extends MarshalByRefObject implements IDisposable

Visual Basic	NotInheritable Public Class RenderToSurface Inherits MarshalByRefObject Implements IDisposable
C#	public sealed class RenderToSurface : MarshalByRefObject, IDisposable
C++	public ref class RenderToSurface sealed : MarshalByRefObject, IDisposable
JScript	public final class RenderToSurface 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 RenderToSurface 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 RenderToSurface.OnResetDevice method is called or after the Device is reset.

Methods

Method Description

BeginScene Begins a scene.

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

EndScene Ends a scene.

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

Finalize Allows the RenderToSurface 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.RenderToSurface.Disposing event when called from within a derived class.

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

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

RenderToSurface Initializes a new instance of the RenderToSurface class.

UpdateUnmanagedPointer Updates the unmanaged pointer for this RenderToSurface 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 render surface.

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

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

Event	Description
Disposing	Occurs when the Dispose method is called or when the RenderToSurface 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 RenderToSurface.OnResetDevice method is called or after the Device is reset.

Method	Description
BeginScene	Begins a scene.
Dispose	Immediately releases the unmanaged resources used by the RenderToSurface object.
EndScene	Ends a scene.
Equals	Returns a value that indicates whether the current instance is equal to a specified object.
Finalize	Allows the RenderToSurface 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.RenderToSurface.Disposing event when called from within a derived class.
raise_Lost	Raises a RenderToSurface.Lost event when called from within a derived class.
raise_Reset	Raises a RenderToSurface.Reset event when called from within a derived class.
RenderToSurface	Initializes a new instance of the RenderToSurface class.
UpdateUnmanagedPointer	Updates the unmanaged pointer for this RenderToSurface 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 render surface.
Disposed	Gets a value that indicates whether the object is disposed.
UnmanagedComPointer	Returns the unmanaged Component Object Model (COM) ID3DXRenderToSurface interface pointer.

Inheritance Hierarchy

Object
MarshalByRefObject
RenderToSurface

Remarks

To provide a custom render view, a surface can be configured using a separate viewport by calling RenderToSurface.BeginScene.

If the surface is not a render target, a compatible render target is used, and the result is copied to the surface at the end of the scene.

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