Sign in Join
FPDoc Onlineexperiment

ComparePoints function deprecated

In unit LCLProc

Use LazUtilities.ComparePoints instead

Deprecated. Use LazUtils.ComparePoints instead. Compares the specified TPoint values to get their relative order.

Declaration

pascal
function ComparePoints(p1: TPoint; p2: TPoint): Integer

Arguments

p1

First TPoint instance for the comparison.

p2

Second TPoint instance for the comparison.

Function result

Relative order for the compared TPoint values.

Description

ComparePoints is an Integer function used to compare the coordinates in the specified TPoint instances to determine their relative order. The return value contains -1, 0, or 1 for the following conditions:

-1
p1.y is smaller than p2.y, or p1.x is smaller than p2.x.
0
p1 and p2 have the same x and y values.
1
p1.y is larger than p2.y, or p1.x is larger than p2.x.

See also

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