Graphics.SetClip(const Region*, CombineMode) method

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 Region object.

Syntax

Status SetClip(
  [in]  const Region *region,
  [in]  CombineMode combineMode
);

Parameters

  • region [in]
    Type: const Region*

    Pointer to a Region 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 Region object and then fills a rectangle.

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

   // Create a Region object.
   Region clipRegion(Rect(0, 0, 200, 100));

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

   // 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

See also

Graphics

CombineMode

Graphics::GetClip

GetClipBounds Methods

IntersectClip Methods

Graphics::IsClipEmpty

Region

Graphics::ResetClip

TranslateClip Methods

Clipping with a Region

Clipping

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012