VolumeLoader.FromStream Method

Language:

Creates a volume from a file in memory.

Definition

Visual Basic Public Shared Sub FromStream( _
    ByVal destVolume As Volume, _
    ByRef destPalette As PaletteEntry, _
    ByVal destBox As Box, _
    ByVal stream As Stream, _
    ByVal readBytes As Integer, _
    ByVal filter As Filter, _
    ByVal colorKey As Integer _
)

C# public static void FromStream(
    Volume destVolume,
    out PaletteEntry destPalette,
    Box destBox,
    Stream stream,
    int readBytes,
    Filter filter,
    int colorKey
);

C++ public:
static void FromStream(
    Volume^ destVolume,
    [Out] PaletteEntry% destPalette,
    Box destBox,
    Stream^ stream,
    int readBytes,
    Filter filter,
    int colorKey
);

JScript public static function FromStream(
    destVolume : Volume,
    destPalette : PaletteEntry,
    destBox : Box,
    stream : Stream,
    readBytes : int,
    filter : Filter,
    colorKey : int
);

Visual Basic	Public Shared Sub FromStream( _ ByVal destVolume As Volume, _ ByRef destPalette As PaletteEntry, _ ByVal destBox As Box, _ ByVal stream As Stream, _ ByVal readBytes As Integer, _ ByVal filter As Filter, _ ByVal colorKey As Integer _ )
C#	public static void FromStream( Volume destVolume, out PaletteEntry destPalette, Box destBox, Stream stream, int readBytes, Filter filter, int colorKey );
C++	public: static void FromStream( Volume^ destVolume, [Out] PaletteEntry% destPalette, Box destBox, Stream^ stream, int readBytes, Filter filter, int colorKey );
JScript	public static function FromStream( destVolume : Volume, destPalette : PaletteEntry, destBox : Box, stream : Stream, readBytes : int, filter : Filter, colorKey : int );

Parameters

destVolume Microsoft.DirectX.Direct3D.Volume
A Volume object that specifies the destination volume.

destPalette Microsoft.DirectX.Direct3D.PaletteEntry[]
Array of PaletteEntry structures that represent a 256-color palette to fill in, or 0.

destBox Microsoft.DirectX.Direct3D.Box
A Box structure that specifies the destination box. Omit this parameter to specify the entire volume.

stream System.IO.Stream
A Stream that contains the source volume texture in memory.

readBytes System.Int32
Size of the file in memory, in bytes.

filter Microsoft.DirectX.Direct3D.Filter
One or more Filter flags that control how the image is filtered.

colorKey System.Int32
An Int32 value to replace with transparent black, or 0 to disable the color key. This is always a 32-bit ARGB color that is independent of the source image format. Alpha is significant, and usually should be set to FF for opaque color keys. For example, for opaque black, the value is equal to 0xFF000000.

Remarks

This method supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga. It handles conversion to and from compressed texture formats.

Writing to a non-level-zero surface of the volume texture does not cause the dirty rectangle to be updated. If FromFile is called and the texture is not already dirty (which is unlikely under normal usage scenarios), the application must explicitly call VolumeTexture.AddDirtyBox on the volume texture.

Exceptions

InvalidCallException The method call is invalid. For example, a method's parameter might contain an invalid value.

InvalidDataException The data is invalid.

destVolume	Microsoft.DirectX.Direct3D.Volume A Volume object that specifies the destination volume.
destPalette	Microsoft.DirectX.Direct3D.PaletteEntry[] Array of PaletteEntry structures that represent a 256-color palette to fill in, or 0.
destBox	Microsoft.DirectX.Direct3D.Box A Box structure that specifies the destination box. Omit this parameter to specify the entire volume.
stream	System.IO.Stream A Stream that contains the source volume texture in memory.
readBytes	System.Int32 Size of the file in memory, in bytes.
filter	Microsoft.DirectX.Direct3D.Filter One or more Filter flags that control how the image is filtered.
colorKey	System.Int32 An Int32 value to replace with transparent black, or 0 to disable the color key. This is always a 32-bit ARGB color that is independent of the source image format. Alpha is significant, and usually should be set to FF for opaque color keys. For example, for opaque black, the value is equal to 0xFF000000.

InvalidCallException	The method call is invalid. For example, a method's parameter might contain an invalid value.
InvalidDataException	The data is invalid.