SetAlphaImage Method

Summary

Replaces existing alpha channel data or creates new alpha channel data.

Syntax

Objective-C

C++

Java

public void SetAlphaImage( 
   RasterImage alphaImage 
)

Public Sub SetAlphaImage( _ 
   ByVal alphaImage As RasterImage _ 
)

- (BOOL)setAlphaImage:(LTRasterImage *)alphaImage error:(NSError **)error

public void setAlphaImage(RasterImage alphaImage)

public: 
void SetAlphaImage(  
   RasterImage^ alphaImage 
)

Parameters

alphaImage
Source RasterImage which references the image that is used to create or replace the alpha channel data.

Remarks

Typically, an alpha channel contains a mask that is used for transparency. This method, together with CreateAlphaImage and the LEADTOOLS region processing methods, lets you use the alpha channel to implement transparency.

Only 16-bit, 32-bit and 64-bit images can have an alpha channel. If the image is of any other color resolution, this method converts the image to 32-bit before it replaces the alpha channel. (If you want 16-bit, you should change it using ColorResolutionCommand, if necessary, before calling this method.)

For 64-bit images, the alphaImage parameter is converted to 16 bit grayscale before replacing the alpha channel. If the image is 48-bit, it will be converted to 64-bit and then have the alpha information added to it.

The alphaImage parameter does not have to be grayscale. This method converts the data from the alphaImage parameter to the necessary grayscale or 1-bit format as it replaces the alpha channel in the image. (The alphaImage, itself, remains unchanged.)

This method does not support signed images.

For more information, refer to Implementing Transparency.

For more information, refer to Saving A Region.

Example

For an example, refer to CreateAlphaImage.

Requirements

Target Platforms