Sign in Join
FPDoc Onlineexperiment

SubtractRect function

In unit LCLIntf

Computes the bounding box with the geometric difference between two rectangles.

Declaration

pascal
function SubtractRect(out lprcDst: TRect; const lprcSrc1: TRect; 
 const lprcSrc2: TRect): Boolean

Arguments

lprcDst
lprcSrc1
lprcSrc2

The rectangle to subtract.

Function result

False when the resulting rectangle is empty.

Description

When the rectangles do not overlap completely in either x or y direction, the result is the first rectangle (lprcSrc1).

Otherwise the overlapping area is excluded from the first rectangle.

The bounding box is the rectangle that covers the entire resulting area.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.