Volume Class

Language:

Manipulates volume resources.

Definition

Visual Basic NotInheritable Public Class Volume
Inherits MarshalByRefObject
Implements IDisposable

C# public sealed class Volume : MarshalByRefObject, IDisposable

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

JScript public final class Volume extends MarshalByRefObject implements IDisposable

Visual Basic	NotInheritable Public Class Volume Inherits MarshalByRefObject Implements IDisposable
C#	public sealed class Volume : MarshalByRefObject, IDisposable
C++	public ref class Volume sealed : MarshalByRefObject, IDisposable
JScript	public final class Volume 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 Volume object is finalized and collected by the garbage collector of the .NET common language runtime.

Methods

Method Description

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

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

FreePrivateData Frees the specified private data associated with the current volume.

GetContainer Provides access to the parent volume texture object, if the current surface is a child level of a volume texture.

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.

GetPrivateData Copies the private data associated with the volume to a provided buffer.

LockBox Locks a box on a volume resource.

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

SetPrivateData Associates data with the volume that is intended for use by the application, not by Microsoft Direct3D.

UnlockBox Unlocks a box on a volume resource.

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

Volume Initializes a new instance of the Volume class.

Properties

Property Description

Description Retrieves the description of a volume.

Device Retrieves the Direct3D device associated with a sprite object.

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

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

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

Method	Description
Dispose	Immediately releases the unmanaged resources used by the Volume object.
Finalize	Allows the Volume object to free resources before it is destroyed by the garbage collector.
FreePrivateData	Frees the specified private data associated with the current volume.
GetContainer	Provides access to the parent volume texture object, if the current surface is a child level of a volume texture.
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.
GetPrivateData	Copies the private data associated with the volume to a provided buffer.
LockBox	Locks a box on a volume resource.
raise_Disposing	Raises the Microsoft.DirectX.Direct3D.Volume.Disposing event when called from within a derived class.
SetPrivateData	Associates data with the volume that is intended for use by the application, not by Microsoft Direct3D.
UnlockBox	Unlocks a box on a volume resource.
UpdateUnmanagedPointer	Updates the unmanaged pointer for this Volume object. This method supports the Microsoft .NET Framework infrastructure and is not intended to be used directly in your code.
Volume	Initializes a new instance of the Volume class.

Property	Description
Description	Retrieves the description of a volume.
Device	Retrieves the Direct3D device associated with a sprite object.
Disposed	Gets a value that indicates whether the object is disposed.
UnmanagedComPointer	Returns the unmanaged Component Object Model (COM) IDirect3DVolume9 interface pointer.

Inheritance Hierarchy

Object
MarshalByRefObject
Volume

Class Information

Namespace Microsoft.DirectX.Direct3D

Assembly Microsoft.DirectX.Direct3D (microsoft.directx.direct3d.dll)

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

Namespace	Microsoft.DirectX.Direct3D
Assembly	Microsoft.DirectX.Direct3D (microsoft.directx.direct3d.dll)
Strong Name	Microsoft.DirectX.Direct3D, 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