Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.12.17
MaskImage Property
See Also 
Leadtools.Codecs Namespace > CodecsPsdLayerInfo Class : MaskImage Property




The transparency mask channel of the saved PSD layer.

Syntax

Visual Basic (Declaration) 
Public Property MaskImage As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As CodecsPsdLayerInfo
Dim value As RasterImage
 
instance.MaskImage = value
 
value = instance.MaskImage
C# 
public RasterImage MaskImage {get; set;}
Managed Extensions for C++ 
public: __property RasterImage get_MaskImage();
public: __property void set_MaskImage( 
   RasterImage value
);
C++/CLI 
public:
property RasterImage MaskImage {
   RasterImage get();
   void set (RasterImage value);
}

Return Value

A RasterImage object that specifies the transparency mask channel of the saved PSD layer.

Example

Remarks

This is an 8-bit grayscale image. The value of each pixel indicates the amount of transparency the data of the original image has at this point. For example, if the value is 0xFF at a certain point, the pixel value of the layer image at that point is not transparent at all. If the value was 0x00, the pixel value of the layer image at that point is fully transparent. If the value is between these two, it indicates the degree of transparency the pixel value of the layer image has at that point.

When loading, if you set the LoadMaskImage property to true, then this property will hold an RasterImage object that represents the transparency mask channel found in the PSD file.

If the mask image does not need to be loaded, pass false to LoadMaskImage. The value of MaskImage will not be used. Passing false to LoadMaskImage saves the transparency mask as full white image, which represents full visibility of the layer.

When saving, if this is a valid image, then it should be of the same width and height as the corresponding layer image. It should also be an 8-bit grayscale image.

For more information, refer to FILE FORMATS SPECIFICATION from Adobe.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also