StartMagGlass method (Main Control)

Builder Syntax	int __fastcall StartMagGlass(int nWidth, int nHeight, int nZoom, Graphics::TColor clrPen, Graphics::TColor,clrBack, bool bEllipse, int nBorderSize, bool b3D, int nCrosshair, bool bIgnoreRgn, bool bCenter);
Delphi Syntax	function StartMagGlass (nWidth :Integer; nHeight:Integer; nZoom :Integer; clrPen : TCOLOR; clrBack : TCOLOR; bEllipse:Boolean; nBorderSize : Integer; b3D : Boolean; nCrosshair: Integer; bIgnoreRgn: Boolean; bCenter : Boolean):Integer;
Overview	Refer to Using the Magnifying Glass

Remarks

Starts the Magnify Glass procedure.

The appearance of the magnifying glass depends on the values of bEllipse, clrPen, b3D and nBorderSize. This can be seen in the table below:

bEllipse	b3D	nBorderSize	clrPen	Result
TRUE	Ignored	Valid	Valid	An elliptical magnifying glass of border size nBorderSize and border color clrPen.
FALSE	FALSE	Valid	Valid	A rectangular magnifying glass with a flat border of width nBorderSize and border color clrPen.
FALSE	TRUE	Ignored	Ignored	A rectangular magnifying glass with a 3D border having a set width and color.

The following properties can be used to control the painting options for the magnifying glass:

The cursor for the magnifying glass can have one of the following default shapes:

When bEllipse = TRUE, the default cursor will be:

$image\MagGls.gif$

When bEllipse = FALSE, the default cursor will be:

$image\MagGls2.gif$

A custom shape can be used by setting the following property:

For an example that shows how to set a custom cursor, refer to:

Elements:	StopMagGlass method, MagGlassPaintPalette property, MagGlassBitonalScaling property, MagGlassPaintDither property, MagGlassPaintScaling property, MagGlassMaskCount property, MagGlassMask property
Topics:	Raster Images: Displaying Images