Visual Basic (Declaration) | |
---|---|
Overloads Public Function Load( _ ByVal stream As Stream, _ ByVal offset As Long, _ ByVal count As Long, _ ByVal bitsPerPixel As Integer, _ ByVal order As CodecsLoadByteOrder, _ ByVal firstPage As Integer, _ ByVal lastPage As Integer _ ) As RasterImage |
Visual Basic (Usage) | Copy Code |
---|---|
|
C# | |
---|---|
public RasterImage Load( Stream stream, long offset, long count, int bitsPerPixel, CodecsLoadByteOrder order, int firstPage, int lastPage ) |
Managed Extensions for C++ | |
---|---|
public: RasterImage Load( Stream* stream, long offset, long count, int bitsPerPixel, CodecsLoadByteOrder order, int firstPage, int lastPage ) |
C++/CLI | |
---|---|
public: RasterImage Load( Stream^ stream, long offset, long count, int bitsPerPixel, CodecsLoadByteOrder order, int firstPage, int lastPage ) |
Parameters
- stream
- A Stream containing the image data to load.
- offset
- Offset from the beginning of the stream at which loading should start.
- count
- Total size of the image file data.
- 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. - 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 stream.
Return Value
The RasterImage object that this method loads.Visual Basic | Copy Code |
---|---|
RasterCodecs.Load(Stream, long, long, int, CodecsLoadByteOrder, int, int) |
C# | Copy Code |
---|---|
RasterCodecs.Load(Stream, long, long, int, CodecsLoadByteOrder, int, int) |
This method can be used to load an image file that is embedded in another stream.
The location of the image is specified as shown in the following simple illustration:
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.
This method will load all the pages in a multipage file. The resulting image will have the same bits/pixel and color order value of the image as it was stored in the file.
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