Load(Uri,int,CodecsLoadByteOrder,int,int) Method

Summary

Loads the specified image URL using specified options.

Syntax

C++

public RasterImage Load( 
   Uri uri, 
   int bitsPerPixel, 
   CodecsLoadByteOrder order, 
   int firstPage, 
   int lastPage 
)

Public Overloads Function Load( _ 
   ByVal uri As Uri, _ 
   ByVal bitsPerPixel As Integer, _ 
   ByVal order As CodecsLoadByteOrder, _ 
   ByVal firstPage As Integer, _ 
   ByVal lastPage As Integer _ 
) As RasterImage

public: 
RasterImage^ Load(  
   Uri^ uri, 
   int bitsPerPixel, 
   CodecsLoadByteOrder order, 
   int firstPage, 
   int lastPage 
)

Parameters

uri
The Uri containing the input image 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-bit, 24-bit, 32-bit, 48-bit, 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.

Remarks

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

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 option parameters before calling this method.

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

For supported formats, refer to Summary of All Supported 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.

LEADTOOLS supports the following URI schemes:

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.

If uri points to a resource in a UriSchemeHttp, UriSchemeHttps or UriSchemeFtp, then this RasterCodecs will attempt to download image data in an iterative fashion by creating a temporary buffer. The size of this buffer can be determined and changed by setting up the UriOperationBufferSize prior to calling this method.

For authenticity and proxy settings, refer to UriOperationCredentials and UriOperationProxy.

Example

This example will load an image from a uri with different bits per pixel

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
public void LoadUri2Example() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Load the image with 1 bits/pixel 
   Uri uri = new Uri(@"https://www.leadtools.com/images/page_graphics/leadlogo.png"); 
   RasterImage image = codecs.Load(uri, 1, CodecsLoadByteOrder.Rgb, 1, 1); 
 
   // Show information about tha image 
   Console.WriteLine("Size: {0} by {1} pixels", image.Width, image.Height); 
   Console.WriteLine("Bits/Pixel: {0}", image.BitsPerPixel); 
   image.Dispose(); 
 
   // Clean up 
   codecs.Dispose(); 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Sub LoadUri2Example() 
   Dim codecs As New RasterCodecs() 
 
   ' Load the image with 1 bits/pixel 
   Dim uri As New Uri("https://www.leadtools.com/images/15-homepg-banner.jpg") 
   Dim image As RasterImage = codecs.Load(uri, 1, CodecsLoadByteOrder.Rgb, 1, 1) 
 
   ' Show information about tha image 
   Console.WriteLine("Size: {0} by {1} pixels", image.Width, image.Height) 
   Console.WriteLine("Bits/Pixel: {0}", image.BitsPerPixel) 
   image.Dispose() 
 
   ' Clean up 
   codecs.Dispose() 
End Sub

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Overload List

Loading and Saving Images

Loading and Saving Large TIFF / BigTIFF Files

Speeding Up 1-Bit Documents

Fast File Info

Download our FREE evaluation

Help Version 20.0.2020.4.3