←Select platform

LoadCmykPlanesAsync Method

Summary

Loads CMYK TIFF or JPEG streams as CMYK and avoids the colorspace conversion to RGB.

Syntax

WinRT C#

C++

public IAsyncOperation<RasterImage> LoadCmykPlanesAsync(  
   ILeadStream stream, 
   int bitsPerPixel, 
   int pageNumber 
)

Public Function LoadCmykPlanesAsync( _ 
   ByVal stream As ILeadStream, _ 
   ByVal bitsPerPixel As Integer, _ 
   ByVal pageNumber As Integer _ 
) As IAsyncOperation(Of RasterImage)

public IAsyncOperation<RasterImage> LoadCmykPlanesAsync(  
   ILeadStream stream, 
   int bitsPerPixel, 
   int pageNumber 
)

 function Leadtools.Codecs.RasterCodecs.LoadCmykPlanesAsync(  
   stream , 
   bitsPerPixel , 
   pageNumber  
)

public: 
IAsyncOperation<RasterImage^>^ LoadCmykPlanesAsync(  
   ILeadStream^ stream, 
   int bitsPerPixel, 
   int pageNumber 
)

Parameters

stream
A ILeadStream containing the data of the image file to load. The image data must be CMYK, otherwise the method will fail and throw an exception.

bitsPerPixel
Resulting image pixel depth. Possible values are:

Value	Meaning
8	Each plane will be a grayscale 8 bits per pixel image.
16	Each plane will be a grayscale 16 bits per pixel image. Not available for JPEG

pageNumber
1-based index of the page from which the planes should be loaded.

Return Value

When this method completes, it returns a RasterImage. The image will contain one page for each of the CMYK planes.

Remarks

If the data does not have to be loaded as CMYK, use Load or LoadAsync.

Support for 16-bit grayscale images is only available in the Document/Medical Imaging editions.

This method will fail if the input file is not TIFF or JPEG CMYK. Note that not all the pages should be CMYK - it is enough if only the page that you wish to load is CMYK.

Only the following memory load options are supported by this method:

This method uses the values of RasterCodecs.Options.Tiff.Load.ImageFileDirectoryOffset.

If the image being loaded contains alpha channel information, it will be stored in the 5th page of the returned image.

Use RasterImagePainter.PaintCmykPlanes to display the array and SaveCmykPlanes to save an image as a CMYK TIFF or JPEG file.

If you want to convert the CMYK array to a regular BGR image and use the other methods or save to a file format other than TIFF or JPEG CMYK, use ColorMergeCommand and set the ColorMergeCommand.Type to ColorMergeCommandType.Cmyk.

If you have an alpha image, use RasterImage.SetAlphaImage to set the alpha image.

You can apply image processing on each individual image. This allows you to process each color plane separately.

If you want to load a non-CMYK file as an array of color plane, use the normal Load or LoadAsync methods and then use ColorSeparateCommand and RasterImage.CreateAlphaImage method.

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Handling CMYK Files as Separate Images

Help Version 19.0.2017.10.27

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies