SaveAsync(RasterCodecs,RasterImage,ILeadStream,RasterImageFormat,int) Method

Summary

Asynchronously saves a RasterImage to a LEAD stream in any of the supported compressed or uncompressed formats.

Syntax

public static Task SaveAsync( 
   this RasterCodecs rasterCodecs, 
   RasterImage image, 
   ILeadStream stream, 
   RasterImageFormat format, 
   int bitsPerPixel 
)

Parameters

rasterCodecs

RasterCodecs object to perform the operation.

image

The RasterImage object that holds the image data.

stream

The stream where the image data will be saved.

format

The output file format. For valid values, refer to

Summary of All Supported File Formats.

bitsPerPixel

Resulting file's pixel depth. Note that not all bits per pixel are available to all file formats. For valid values, refer to Summary of All Supported File Formats. If bitsPerPixel is 0, the image will be stored using the closest bits per pixel value supported by that format. For example, if a file format supports 1-, 4-, and 24-bits per pixel, and RasterImage.BitsPerPixel is 5, the file will be stored as 24-bit. Likewise, if RasterImage.BitsPerPixel is 2, the file will be stored as 4-bit.

Return Value

A Task that represents the asynchronous operation.

Remarks

This topic is part of RasterCodecs support for .NET async/await support. Refer to RasterCodecs Async Operations for more information.

For general information on saving images using RasterCodecs, refer to Save.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
public async Task<MemoryStream> LoadAsPng(string fileName) 
{ 
   // For .NET Framework: Add a reference to Leadtools.Async to get the async support as extension methods 
   // For .NET Standard: async support is included. 
 
   MemoryStream memoryStream = new MemoryStream(); 
 
   using (RasterCodecs codecs = new RasterCodecs()) 
   { 
      // Create an ILeadStream for the output file 
      using (ILeadStream inputLeadStream = LeadStream.Factory.OpenFile(fileName)) 
      // ILeadStream for the output stream 
      using (ILeadStream outputLeadStream = LeadStream.Factory.FromStream(memoryStream)) 
      { 
         // Load the image 
         using (RasterImage image = await codecs.LoadAsync(inputLeadStream, 1)) 
         { 
            // Save it to the output stream 
            await codecs.SaveAsync(image, outputLeadStream, RasterImageFormat.Png, 0); 
         } 
      } 
   } 
 
   return memoryStream; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Async Function LoadAsPng(fileName As String) As Tasks.Task(Of Stream) 
   ' For .NET Framework: Add a reference To Leadtools.Async To Get the async support As extension methods 
   ' For .NET Standard Async support Is included. 
 
   Dim memoryStream As New MemoryStream() 
 
   Using codecs As New RasterCodecs() 
      ' Create an ILeadStream for the output file 
      Using inputLeadStream As ILeadStream = LeadStream.Factory.OpenFile(fileName) 
         ' ILeadStream for the output stream 
         Using outputLeadStream As ILeadStream = LeadStream.Factory.FromStream(memoryStream) 
            ' Load the image 
            Using image As RasterImage = Await codecs.LoadAsync(inputLeadStream, 1) 
               ' Save it to the output stream 
               Await codecs.SaveAsync(image, outputLeadStream, RasterImageFormat.Png, 0) 
            End Using 
         End Using 
      End Using 
   End Using 
 
   Return memoryStream 
End Function

Requirements

For .NET Framework: A reference to the Leadtools.Async.dll assembly is required to use this functionality.

For .NET Standard: This functionality is included in the Leadtools.Codecs.dll assembly.

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Leadtools.Codecs Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies