VolumeLoader.FromFile(Volume,PaletteEntry,String,Filter,Int32,ImageInformation) Method (Microsoft.DirectX.Direct3D)

  • Article

Loads a volume from a file.

Definition

Visual Basic Public Shared Sub FromFile( _
    ByVal destVolume As Volume, _
    ByRef destPalette As PaletteEntry, _
    ByVal srcFile As String, _
    ByVal filter As Filter, _
    ByVal colorKey As Integer, _
    ByRef srcInformation As ImageInformation _
)
C# public static void FromFile(
    Volume destVolume,
    out PaletteEntry destPalette,
    string srcFile,
    Filter filter,
    int colorKey,
    ref ImageInformation srcInformation
);
C++ public:
static void FromFile(
    Volume^ destVolume,
    [Out] PaletteEntry% destPalette,
    StringLeave Site^ srcFile,
    Filter filter,
    int colorKey,
    ImageInformation% srcInformation
);
JScript public static function FromFile(
    destVolume : Volume,
    destPalette : PaletteEntry,
    srcFile : String,
    filter : Filter,
    colorKey : int,
    srcInformation : ImageInformation
);

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.
srcFile System.String
String that specifies the file name.
filter Microsoft.DirectX.Direct3D.Filter
One or more Filter flags that control how the image is filtered.
colorKey System.Int32
An Int32Leave Site 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.
srcInformation Microsoft.DirectX.Direct3D.ImageInformation
An ImageInformation structure to fill with a description of the data in the source image file, or 0.

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 any surface except the "zero" level 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.

See Also