Share via

SurfaceLoader.FromFile Method ()

  • Article

Loads a surface from a file.

Overload List

public static void FromFile(Surface, out PaletteEntry, Rectangle, string, Filter, int);
public static void FromFile(Surface, out PaletteEntry, Rectangle, string, Filter, int, ref ImageInformation);
public static void FromFile(Surface, out PaletteEntry, Rectangle, string, Rectangle, Filter, int);
public static void FromFile(Surface, out PaletteEntry, Rectangle, string, Rectangle, Filter, int, ref ImageInformation);
public static void FromFile(Surface, out PaletteEntry, string, Filter, int);
public static void FromFile(Surface, out PaletteEntry, string, Filter, int, ref ImageInformation);
public static void FromFile(Surface, out PaletteEntry, string, Rectangle, Filter, int);
public static void FromFile(Surface, out PaletteEntry, string, Rectangle, Filter, int, ref ImageInformation);
public static void FromFile(Surface, Rectangle, string, Rectangle, Filter, int);
public static void FromFile(Surface, Rectangle, string, Rectangle, Filter, int, ref ImageInformation);
public static void FromFile(Surface, string, Filter, int);
public static void FromFile(Surface, string, Filter, int, ref ImageInformation);
public static void FromFile(Surface, string, Rectangle, Filter, int);
public static void FromFile(Surface, string, Rectangle, Filter, int, ref ImageInformation);

Remarks

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

Writing to a surface level other than zero does not cause the dirty rectangle to be updated. If SurfaceLoader.FromFile is called and the surface is not already dirty (which is unlikely under normal usage scenarios), the application must explicitly call Texture.AddDirtyRect on the surface.

Exceptions

InvalidCallException

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

InvalidDataException

The data is invalid.