Help Center

CGpGraphics.ExcludeClipRectmethod

GraphicsmethodCGpGraphics.incdoc-orphan
No implementation located. This member is documented, but the source scan found no matching declaration. It is likely declared in a header this scan does not resolve, or provided by a macro.

Syntax

FUNCTION ExcludeClipRect (BYVAL rc AS GpRectF PTR) AS GpStatus
FUNCTION ExcludeClipRect (BYVAL rc AS GpRect PTR) AS GpStatus
FUNCTION ExcludeClipRect (BYVAL x AS SINGLE, BYVAL y AS SINGLE, BYVAL nWidth AS SINGLE, BYVAL nHeight AS SINGLE) AS GpStatus
FUNCTION ExcludeClipRect (BYVAL x AS INT_, BYVAL y AS INT_, BYVAL nWidth AS INT_, BYVAL nHeight AS INT_) AS GpStatus
FUNCTION ExcludeClipRect (BYVAL pRegion AS CGpRegion PTR) AS GpStatus
Also documented as ExcludeClip — one description covers them all.

Parameters

NameDescription
rcReference to a rectangle to use to update the clipping region.
xThe x-coordinate of the upper-left corner of the rectangle.
yThe y-coordinate of the upper-left corner of the rectangle.
nWidthThe width of the rectangle.
nHeightThe height of the rectangle.
pRegionPointer to a Region object.

Description

Updates the clipping region to the portion of itself that does not intersect the specified rectangle.

Updates the clipping region with the portion of itself that does not overlap the specified region.

Example

' ======================================================================================== ' The following example uses a rectangle to update a clipping region and then draws a ' rectangle that demonstrates the updated clipping region. ' ======================================================================================== SUB Example_ExcludeClip (BYVAL hdc AS HDC)

' // Create a graphics object from the window device context DIM graphics AS CGpGraphics = hdc ' // Set the scale transform graphics.ScaleTransformForDpi

' // Create a GpRect object, and set the clipping region to its exclusion. DIM excludeRect AS GpRect = (125, 50, 150, 150) graphics.ExcludeClip(@excludeRect)

' // Fill a rectangle to demonstrate the clipping region. graphics.FillRectangle(@CGpSolidBrush(ARGB_BLUE), 0, 0, 400, 250)

END SUB ' ========================================================================================

Reference

  • Include file CGpGraphics.inc
  • Documented in Graphics/GdiPlus Classes/CGpGraphics Classes.md
  • Topic: CGpGraphics Class