Graphics.SetClip(const GraphicsPath*, CombineMode) method

Article
03/07/2012

Applies to: desktop apps only

The Graphics::SetClip method updates the clipping region of this Graphics object to a region that is the combination of itself and the region specified by a graphics path. If a figure in the path is not closed, this method treats the nonclosed figure as if it were closed by a straight line that connects the figure's starting and ending points.

Syntax

Status SetClip(
  [in]  const GraphicsPath *path,
  [in]  CombineMode combineMode
);

Parameters

path [in]
Type: const GraphicsPath*

Pointer to a GraphicsPath object that specifies the region to be combined with the clipping region of this Graphics object.
combineMode [in]
Type: CombineMode

Optional. Element of the CombineMode enumeration that specifies how the specified region is combined with the clipping region of this Graphics object. The default value is CombineModeReplace.

Return value

Type:

Type: Status****

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Examples

The following example updates the clipping region with a GraphicsPath object and then fills a rectangle.

VOID Example_SetClip3(HDC hdc)
{
   Graphics graphics(hdc);

   // Create a GraphicsPath object.
   GraphicsPath clipPath;
   clipPath.AddEllipse(0, 0, 200, 100);

   // Set the clipping region with hRegion.
   graphics.SetClip(&clipPath);

   // Fill a rectangle to demonstrate the clipping region.
   graphics.FillRectangle(&SolidBrush(Color(255, 0, 0, 0)), 0, 0, 500, 500);
}

Requirements

Minimum supported client	Windows XP, Windows 2000 Professional
Minimum supported server	Windows 2000 Server
Product	GDI+ 1.0
Header	Gdiplusgraphics.h (include Gdiplus.h)
Library	Gdiplus.lib
DLL	Gdiplus.dll

Share via