LEADTOOLS Image File Support (Leadtools.Codecs assembly)

ConvertAsync Method

Show in webframe







A Leadtools.ILeadStream containing the data of the input image file.
A Leadtools.ILeadStream that will contain the data of the output image file.
The output file format. For valid values, refer to Summary of All Supported Image File Formats.
New width of the output image. If this value is not 0, then the output file will be resized to the width value. Use a value of 0 if you do not wish to resize the output file.
New height of the output image. If this value is not 0, then the output file will be resized to the height value. Use a value of 0 if you do not wish to resize the output file.
The output image pixel depth. Note that not all bits per pixel are available to all file formats.
A CodecsImageInfo object specifying more options for the conversion.
Converts an image stream from one format to another, creating a new image file in a stream in the new format.
Syntax
public IAsyncAction ConvertAsync( 
   ILeadStream srcStream,
   ILeadStream destStream,
   RasterImageFormat format,
   int width,
   int height,
   int bitsPerPixel,
   CodecsImageInfo info
)
'Declaration
 
Public Function ConvertAsync( _
   ByVal srcStream As ILeadStream, _
   ByVal destStream As ILeadStream, _
   ByVal format As RasterImageFormat, _
   ByVal width As Integer, _
   ByVal height As Integer, _
   ByVal bitsPerPixel As Integer, _
   ByVal info As CodecsImageInfo _
) As IAsyncAction
'Usage
 
Dim instance As RasterCodecs
Dim srcStream As ILeadStream
Dim destStream As ILeadStream
Dim format As RasterImageFormat
Dim width As Integer
Dim height As Integer
Dim bitsPerPixel As Integer
Dim info As CodecsImageInfo
Dim value As IAsyncAction
 
value = instance.ConvertAsync(srcStream, destStream, format, width, height, bitsPerPixel, info)
public IAsyncAction ConvertAsync( 
   ILeadStream srcStream,
   ILeadStream destStream,
   RasterImageFormat format,
   int width,
   int height,
   int bitsPerPixel,
   CodecsImageInfo info
)

            

            
 function Leadtools.Codecs.RasterCodecs.ConvertAsync( 
   srcStream ,
   destStream ,
   format ,
   width ,
   height ,
   bitsPerPixel ,
   info 
)
public:
IAsyncAction^ ConvertAsync( 
   ILeadStream^ srcStream,
   ILeadStream^ destStream,
   RasterImageFormat format,
   int width,
   int height,
   int bitsPerPixel,
   CodecsImageInfo^ info
) 

Parameters

srcStream
A Leadtools.ILeadStream containing the data of the input image file.
destStream
A Leadtools.ILeadStream that will contain the data of the output image file.
format
The output file format. For valid values, refer to Summary of All Supported Image File Formats.
width
New width of the output image. If this value is not 0, then the output file will be resized to the width value. Use a value of 0 if you do not wish to resize the output file.
height
New height of the output image. If this value is not 0, then the output file will be resized to the height value. Use a value of 0 if you do not wish to resize the output file.
bitsPerPixel
The output image pixel depth. Note that not all bits per pixel are available to all file formats.
info
A CodecsImageInfo object specifying more options for the conversion.

Return Value

An asynchronous convert operation on a RasterCodecs object.
Remarks

If you convert to a lower bits-per-pixel format, this method optimizes the colors automatically. For example, when converting a 24-bit file (16 million colors) to an 8-bit file (256 colors) this method selects the best 256 colors to represent the 24-bit image

Note that this is a high-level method that does conversion from all possible formats to all possible formats.

Example
For an example, refer to Convert.
Requirements

Target Platforms

See Also

Reference

RasterCodecs Class
RasterCodecs Members

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.