Public Overloads Function Load( _
   ByVal fileName As String, _
   ByVal width As Integer, _
   ByVal height As Integer, _
   ByVal bitsPerPixel As Integer, _
   ByVal flags As RasterSizeFlags, _
   ByVal order As CodecsLoadByteOrder _
) As RasterImage

Visual Basic (Usage)	Copy Code
Dim instance As RasterCodecs Dim fileName As String Dim width As Integer Dim height As Integer Dim bitsPerPixel As Integer Dim flags As RasterSizeFlags Dim order As CodecsLoadByteOrder Dim value As RasterImage   value = instance.Load(fileName, width, height, bitsPerPixel, flags, order)

public RasterImage Load( 
   string fileName,
   int width,
   int height,
   int bitsPerPixel,
   RasterSizeFlags flags,
   CodecsLoadByteOrder order
)

public:
RasterImage Load( 
   String^ fileName,
   int width,
   int height,
   int bitsPerPixel,
   RasterSizeFlags flags,
   CodecsLoadByteOrder order
) 

Parameters

fileName

A String containing the name of the image file to load.

width

New width of the image in pixels.

height

New height of the image in pixels.

bitsPerPixel

Resulting image pixel depth. Valid values are:

value	meaning
0	Keep the original file's pixel depth (Do not convert).
1 to 8	The specified bits per pixel in the resulting image.
12	12 bits per pixel in the resulting image.
16	16 bits per pixel in the resulting image.
24	24 bits per pixel in the resulting image.
32	32 bits per pixel in the resulting image.
48	48 bits per pixel in the resulting image.
64	64 bits per pixel in the resulting image.

flags

Flag that indicates the type of resizing to use. Possible values are:

Value	Meaning
RasterSizeFlagsRasterSizeFlags.None	Normal resizing
RasterSizeFlagsRasterSizeFlags.Resample	Linear interpolation resizing
RasterSizeFlagsRasterSizeFlags.Bicubic	Bicubic interpolation resizing
RasterSizeFlagsRasterSizeFlags.FavorBlack	Not supported

order

Color order for 16-, 24-, 32-, 48-, and 64-bit images. If the resulting image is less than 16 bits per pixel, this will have no effect since palletized images have no order. The following are valid values.

Value	Meaning
CodecsLoadByteOrder.Rgb	Red, green, and blue color order in memory
CodecsLoadByteOrder.Bgr	Blue, green, and red color order in memory
CodecsLoadByteOrder.Gray	12 or 16-bit grayscale image. 12 and 16-bit grayscale images are only supported in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RgbOrGray	Load the image as red, green, blue OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions
CodecsLoadByteOrder.BgrOrGray	Load the image as blue, green, red OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions
CodecsLoadByteOrder.Romm	ROMM order. ROMM only supports 24 and 48-bit images
CodecsLoadByteOrder.BgrOrGrayOrRomm	Load the image as red, green, blue OR as a 12 or 16-bit grayscale image OR as ROMM. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions only. ROMM only supports 24 and 48-bit color images.

Return Value

This example will load an image from file in a specified size.

Visual Basic

Copy Code

Public Sub LoadResize1Example()    RasterCodecs.Startup()    Dim codecs As RasterCodecs = New RasterCodecs()    Dim srcFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"    Dim destFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "LoadResize1.bmp"    Dim info As CodecsImageInfo = codecs.GetInformation(srcFileName, True)    ' We want to load the image as 320/200    Dim width As Integer = 320    Dim height As Integer = 200    Dim image As RasterImage = codecs.Load(srcFileName, width, height, 0, RasterSizeFlags.Resample, CodecsLoadByteOrder.BgrOrGray)    Debug.Assert(image.Width = width)    Debug.Assert(image.Height = height)    ' Save this image back to disk    codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24)    image.Dispose()    ' Clean up    codecs.Dispose()    RasterCodecs.Shutdown() End Sub

C#

Copy Code

public void LoadResize1Example()  {     RasterCodecs.Startup();     RasterCodecs codecs = new RasterCodecs();       string srcFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp";     string destFileName = LeadtoolsExamples.Common.ImagesPath.Path + "LoadResize1.bmp";       CodecsImageInfo info = codecs.GetInformation(srcFileName, true);       // We want to load the image as 320/200     int width = 320;     int height = 200;       RasterImage image = codecs.Load(        srcFileName,        width,        height,        0,        RasterSizeFlags.Resample,        CodecsLoadByteOrder.BgrOrGray);       Debug.Assert(image.Width == width);     Debug.Assert(image.Height == height);       // Save this image back to disk     codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24);     image.Dispose();       // Clean up     codecs.Dispose();     RasterCodecs.Shutdown();  }

This method resizes a file to the desired width, height, and bits per pixel as it loads. Note that the original file is not completely loaded into memory. This method is ideal for sampling large images (i.e. generating a thumbnail) without the memory overhead of loading the large file itself.

The file can be in any supported image file format and bits per pixel, whether compressed or uncompressed.

LEADTOOLS will attempt to load corrupted files, so you can see at least a portion of the image. For these images, the load methods succeed, but LoadStatus will return an error code.

Use the CodecsLoadOptions class to set up other load options parameters before calling this method.

Support for 12 and 16-bit grayscale images is only available in the Document/Medical Imaging editions.

For supported formats, refer to Summary of All Supported Image File Formats.

LEADTOOLS loads all PDF files as Raster PDF uncompressed RasterImageFormat.RasPdf, regardless of the compression and color space used when saving the file.

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Reference