Leadtools.Codecs Namespace > RasterCodecs Class > LoadAsync Method : LoadAsync(ILeadStream,Int32,CodecsLoadByteOrder,Int32,Int32) Method |
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.
public IAsyncOperation<RasterImage> LoadAsync( ILeadStream stream, int bitsPerPixel, CodecsLoadByteOrder order, int firstPage, int lastPage )
'Declaration Public Overloads Function LoadAsync( _ ByVal stream As ILeadStream, _ ByVal bitsPerPixel As Integer, _ ByVal order As CodecsLoadByteOrder, _ ByVal firstPage As Integer, _ ByVal lastPage As Integer _ ) As IAsyncOperation(Of RasterImage)
'Usage Dim instance As RasterCodecs Dim stream As ILeadStream Dim bitsPerPixel As Integer Dim order As CodecsLoadByteOrder Dim firstPage As Integer Dim lastPage As Integer Dim value As IAsyncOperation(Of RasterImage) value = instance.LoadAsync(stream, bitsPerPixel, order, firstPage, lastPage)
public IAsyncOperation<RasterImage> LoadAsync( ILeadStream stream, int bitsPerPixel, CodecsLoadByteOrder order, int firstPage, int lastPage )
function Leadtools.Codecs.RasterCodecs.LoadAsync(ILeadStream,Int32,CodecsLoadByteOrder,Int32,Int32)( stream , bitsPerPixel , order , firstPage , lastPage )
public: IAsyncOperation<RasterImage^>^ LoadAsync( ILeadStream^ stream, int bitsPerPixel, CodecsLoadByteOrder order, int firstPage, int lastPage )
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.
LEADTOOLS will attempt to load corrupted files so you can see at least a portion of the image. For such images, the load methods succeed, but the LoadStatus will return an error code.
Valid values for the bitsPerPixel parameter 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. |
Valid values are for the order parameter are:
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. |
Use the CodecsLoadOptions class to set up other load option 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.
The RasterCodecs class supports loading image files asynchronously using the LoadAsync methods. When calling any of these methods, the caller thread will not be blocked and the method will return instantly with an instance of Leadtools.RasterImage that is in a loading status (RasterImage.IsLoading set to true). You should not use the other properties of this object while the object is in loading status.
When the RasterCodecs object finishes loading the image, the various properties of the Leadtools.RasterImage will be populated with the image information and data and the RasterImage.IsLoading property will be set to false.
Do not poll the RasterImage.IsLoading property to determine whether the image has finished loading. Instead, subscribe to the IAsyncOperation.Completed event to get notification when the LoadAsync(String,LeadRect,Int32,CodecsLoadByteOrder,Int32,Int32,Object) operation has completed and whether any errors occurred.
When this method completes, it returns the image as a Leadtools.RasterImage.
RasterCodecsExamples.prototype.LoadFile2Example = function ( ) { Tools.SetLicense ( ) ; with (Leadtools) { with (Leadtools.Codecs) { var codecs = new RasterCodecs(); var loadFile; var image; var info; var bitsPerPixel; var first = 1; var last = 1; // First, test loading as different color byte order and bits per pixel var singlePageFileName = "Assets\\Image1.cmp"; // Get the file information return Tools.AppInstallFolder().getFileAsync(singlePageFileName).then(function (ldFil) { loadFile = ldFil; return codecs.getInformationAsync(LeadStreamFactory.create(loadFile), true, 1) }).then(function (info) { console.info("Order according to info is: ", info.order, ", bits/pixel is: ", info.bitsPerPixel); // Now, load this file with different color byte order and bits per pixel bitsPerPixel = 1; return codecs.loadAsync(LeadStreamFactory.create(loadFile), bitsPerPixel, CodecsLoadByteOrder.rgb, 1, 1) }) .then(function (img) { image = img; console.info("Loaded as ", image.order, " order and ", image.bitsPerPixel, " bits/pixel"); console.assert(bitsPerPixel === image.bitsPerPixel, "bitsPerPixel === image.BitsPerPixel"); image.close(); var multiPageFileName = "Assets\\Eye.gif"; // Get the file information (we are interested in the number of pages) return Tools.AppInstallFolder().getFileAsync(multiPageFileName) }).then(function (loadFile2) { loadFile = loadFile2; return codecs.getInformationAsync(LeadStreamFactory.create(loadFile), true, 1) }) .then(function (inf) { info = inf; console.info("Number of pages according to info: ", info.totalPages); // Load the first page return codecs.loadAsync(LeadStreamFactory.create(loadFile), 0, CodecsLoadByteOrder.bgrOrGray, first, last) }) .then(function (img) { image = img; console.info("Loading pages ", first, "to ", last, ", pages loaded = ", image.pageCount); console.assert(image.pageCount == last - first + 1, "image.pageCount == last - first + 1"); image.close(); // Load the second page first = 2; last = 2; return codecs.loadAsync(LeadStreamFactory.create(loadFile), 0, CodecsLoadByteOrder.bgrOrGray, first, last) }) .then(function (img) { image = img; console.info("Loading pages ", first, "to ", last, ", pages loaded = ", image.pageCount); console.assert(image.pageCount == last - first + 1, "image.pageCount == last - first + 1"); image.close(); // Load from the second page to the second before last page first = 2; last = info.totalPages - 1; return codecs.loadAsync(LeadStreamFactory.create(loadFile), 0, CodecsLoadByteOrder.bgrOrGray, first, last) }) .then(function (img) { image = img; console.info("Loading pages ", first, "to ", last, ", pages loaded = ", image.pageCount); console.assert(image.pageCount == last - first + 1, "image.pageCount == last - first + 1"); image.close(); // load all the pages return codecs.loadAsync(LeadStreamFactory.create(loadFile), 0, CodecsLoadByteOrder.bgrOrGray, 1, -1) }) .then(function (img) { image = img; console.info("Loading all pages, pages loaded = ", image.pageCount); console.assert(image.pageCount === info.totalPages); image.close(); // Clean up codecs.close(); }); } } }
[TestMethod] public async Task LoadFile2Example() { RasterCodecs codecs = new RasterCodecs(); // First, test loading as different color byte order and bits per pixel string singlePageFileName = @"Assets\Image1.cmp"; // Get the file information StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(singlePageFileName); CodecsImageInfo info = await codecs.GetInformationAsync(LeadStreamFactory.Create(loadFile), true, 1); Debug.WriteLine("Order according to info is: {0}, bits/pixel is: {1}", info.Order, info.BitsPerPixel); // Now, load this file with different color byte order and bits per pixel int bitsPerPixel = 1; RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), bitsPerPixel, CodecsLoadByteOrder.Rgb, 1, 1); Debug.WriteLine("Loaded as {0} order and {1} bits/pixel", image.Order, image.BitsPerPixel); Assert.IsTrue(bitsPerPixel == image.BitsPerPixel); image.Dispose(); string multiPageFileName = @"Assets\Eye.gif"; // Get the file information (we are interested in the number of pages) loadFile = await Tools.AppInstallFolder.GetFileAsync(multiPageFileName); info = await codecs.GetInformationAsync(LeadStreamFactory.Create(loadFile), true, 1); Debug.WriteLine("Number of pages according to info: {0}", info.TotalPages); // Load the first page int first = 1; int last = 1; image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 0, CodecsLoadByteOrder.BgrOrGray, first, last); Debug.WriteLine("Loading pages {0} to {1}, pages loaded = {2}", first, last, image.PageCount); Assert.IsTrue(image.PageCount == last - first + 1); image.Dispose(); // Load the second page first = 2; last = 2; image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 0, CodecsLoadByteOrder.BgrOrGray, first, last); Debug.WriteLine("Loading pages {0} to {1}, pages loaded = {2}", first, last, image.PageCount); Assert.IsTrue(image.PageCount == last - first + 1); image.Dispose(); // Load from the second page to the second before last page first = 2; last = info.TotalPages - 1; image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 0, CodecsLoadByteOrder.BgrOrGray, first, last); Debug.WriteLine("Loading pages {0} to {1}, pages loaded = {2}", first, last, image.PageCount); Assert.IsTrue(image.PageCount == last - first + 1); image.Dispose(); // load all the pages image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 0, CodecsLoadByteOrder.BgrOrGray, 1, -1); Debug.WriteLine("Loading all pages, pages loaded = {0}", image.PageCount); Assert.IsTrue(image.PageCount == info.TotalPages); image.Dispose(); // Clean up codecs.Dispose(); }
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2