LBitmapRgn::SetRgnFromMask

#include "ltwrappr.h"

virtual L_INT LBitmapRgn::SetRgnFromMask(LBitmapMask)

/* the LBitmapBase object to be used as a mask */

Creates or updates the associated class object's bitmap region by adding a region that consists of all the white pixels in a 1-bit mask image.

Parameter	Description
LBitmapMask	The 1-bit black-and-white bitmap object used as a mask.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

To update an existing region, you specify how the new region is to be combined with the existing one. For descriptions of the possibilities, refer to Creating a Bitmap Region.

The LBitmapMask parameter is passed by reference and is a required parameter.

Required DLLs and Libraries

LTDIS

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:	LBitmapBase::CreateAlphaBitmap, LBitmapBase::SetAlpha, LBitmapRgn::CreateMaskFromBitmapRgn, LBitmapRgn::SetRgnColorHSVRange, LBitmapRgn::SetRgnColorRGBRange, Class Members
Topics:	Defining and Using a Bitmap Region
	Saving a Region

Example

For an example, refer to LBitmapRgn::SetRgnPolygon.