Microsoft DirectX 9.0 SDK Update (October 2004)

TextureLoader.FromFile Method

Language:

Note: This documentation is preliminary and is subject to change.

Creates a texture from a file.

Definition

Visual Basic .NET Public Shared Function FromFile( _
    ByVal device As Device, _
    ByVal srcFile As String _
) As Texture
C# public static Texture FromFile(
    Device device,
    string srcFile
);
Managed C++ public: static Texture* FromFile(
    Device *device,
    String *srcFile
);
JScript .NET public static function FromFile(
    device : Device,
    srcFile : String
) : Texture;

Parameters

device Microsoft.DirectX.Direct3D.Device. A Device object that represents the device to associate with the texture.
srcFile System.String. String that specifies the file name.

Return Value

Microsoft.DirectX.Direct3D.Texture . A Texture object that represents the created texture object.

Remarks

This method supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga.

Cube textures differ from other surfaces in that they are collections of surfaces. To call Device.SetRenderTarget with a cube texture, select an individual face using CubeTexture.GetCubeMapSurface and pass the resulting surface to Device.SetRenderTarget.

To get the best performance when using FromFile, consider the following:

Exceptions
InvalidCallException The method call is invalid. For example, a method's parameter might contain an invalid value.
InvalidDataException The data is invalid.
NotAvailableException This device does not support the queried technique.
OutOfVideoMemoryException Microsoft Direct3D® does not have enough display memory to perform the operation.
OutOfMemoryException Leave Site Direct3D could not allocate sufficient memory to complete the call.

See Also


© 2004 Microsoft Corporation. All rights reserved. Terms of use.

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