Visual Basic (Declaration) | |
---|---|
Overloads Public 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, _ ByVal firstPage As Integer, _ ByVal lastPage As Integer _ ) As RasterImage |
Visual Basic (Usage) | ![]() |
---|---|
|
C# | |
---|---|
public RasterImage Load( string fileName, int width, int height, int bitsPerPixel, RasterSizeFlags flags, CodecsLoadByteOrder order, int firstPage, int lastPage ) |
Managed Extensions for C++ | |
---|---|
public: RasterImage Load( string* fileName, int width, int height, int bitsPerPixel, RasterSizeFlags flags, CodecsLoadByteOrder order, int firstPage, int lastPage ) |
C++/CLI | |
---|---|
public: RasterImage Load( String^ fileName, int width, int height, int bitsPerPixel, RasterSizeFlags flags, CodecsLoadByteOrder order, int firstPage, int lastPage ) |
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. - firstPage
- 1-based index of the first page to load.
- lastPage
- The 1-based index of the last page to load. Must be greater than or equal to firstPage. You can pass -1 to load from firstPage to the last page in the file.
Return Value
The RasterImage object that this method loads.Visual Basic | ![]() |
---|---|
RasterCodecs.Load(string, int, int, int, RasterSizeFlags, CodecsLoadByteOrder, int, int) |
C# | ![]() |
---|---|
RasterCodecs.Load(string, int, int, int, RasterSizeFlags, CodecsLoadByteOrder, int, int) |
This method resizes a file as it loads, to the desired width, height, and bits per pixel. 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 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family