AddMaskToRegion Method

Summary

Creates or updates the image region by adding a region that consists of all the white pixels in a 1-bit mask image.

Syntax

Objective-C

C++

Java

public void AddMaskToRegion( 
   RasterRegionXForm xform, 
   RasterImage maskImage, 
   RasterRegionCombineMode combineMode 
)

Public Sub AddMaskToRegion( _ 
   ByVal xform As RasterRegionXForm, _ 
   ByVal maskImage As RasterImage, _ 
   ByVal combineMode As RasterRegionCombineMode _ 
)

- (BOOL)addMaskToRegion:(nullable LTRasterRegionXForm *)xform  
              maskImage:(LTRasterImage *)mask  
            combineMode:(LTRasterRegionCombineMode)combineMode  
                  error:(NSError **)error

public void addMaskToRegion( 
  RasterRegionXForm xform,  
  RasterImage maskImage,  
  RasterRegionCombineMode combineMode 
)

public: 
void AddMaskToRegion(  
   RasterRegionXForm^ xform, 
   RasterImage^ maskImage, 
   RasterRegionCombineMode combineMode 
)

Parameters

xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates.

maskImage
The 1-bit black-and-white RasterImage used as a mask.

combineMode
The action to take regarding the existing image region, if one is defined.

Remarks

To update an existing region, you specify how the new region is to be combined with the existing one using the combineMode parameter. For more information, refer to RasterRegionCombineMode.

For more information, refer to Creating a Region.

For more information, refer to Saving A Region.

For more information, refer to Working with the Existing Region.

Example

For an example, refer to CreateMaskFromRegion.

Requirements

Target Platforms