Convert(Stream,Stream,RasterImageFormat,int,int,int,CodecsImageInfo) Method

Summary

Converts an image stream from one format to another, creating a new image file in a stream in the new format.

Syntax

Objective-C

C++

Java

public void Convert( 
   Stream srcStream, 
   Stream destStream, 
   RasterImageFormat format, 
   int width, 
   int height, 
   int bitsPerPixel, 
   CodecsImageInfo info 
)

Public Overloads Sub Convert( _ 
   ByVal srcStream As Stream, _ 
   ByVal destStream As Stream, _ 
   ByVal format As RasterImageFormat, _ 
   ByVal width As Integer, _ 
   ByVal height As Integer, _ 
   ByVal bitsPerPixel As Integer, _ 
   ByVal info As CodecsImageInfo _ 
)

- (BOOL)convertStream:(NSString *)srcFile  
    destinationStream:(NSString *)dstFile  
               format:(LTRasterImageFormat)format  
                width:(NSInteger)width  
               height:(NSInteger)height  
         bitsPerPixel:(NSInteger)bitsPerPixel  
                error:(NSError **)error

public void convert(ILeadStream srcStream, ILeadStream destStream, RasterImageFormat format, int width, int height, int bitsPerPixel, CodecsImageInfo info)

public: 
void Convert(  
   Stream^ srcStream, 
   Stream^ destStream, 
   RasterImageFormat format, 
   int width, 
   int height, 
   int bitsPerPixel, 
   CodecsImageInfo^ info 
)

Parameters

srcStream
A Stream containing the data of the input image file.

destStream
A Stream that will contain the data of the output image file.

format
The output file format. For valid values, refer to Summary of All Supported 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.

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