Difference between revisions of "FindColor"
From SCAR Divi Manual
(→Example) |
|||
| Line 3: | Line 3: | ||
==Definition== | ==Definition== | ||
<source lang="scar" lines="false"> | <source lang="scar" lines="false"> | ||
| − | function FindColor( | + | function FindColor(out X, Y: Integer; const Color, XS, YS, XE, YE: Integer): Boolean; |
</source> | </source> | ||
| Line 10: | Line 10: | ||
==Description== | ==Description== | ||
| − | This function searches for a given color specified by '''Color''' inside of a given search area specified by ''' | + | This function searches for a given color specified by '''Color''' inside of a given search area specified by '''XS''', '''YS''', '''XE''', '''YE''' using a scan-line pattern. The search area is given as a set of upper-left ('''XS''', '''YS''') and lower-right ('''XE''', '''YE''') coordinates which are specified relative to the selected client window. If the given search area is invalid ('''XS''' > '''XE''' or '''YS''' > '''YE'''), an exception is thrown. |
| + | |||
| + | The function returns [[false]] if the color was not found, if it was it returns [[true]] and the coordinates of the found color in ('''X''', '''Y'''). The search will stop after the first instance of the color was found. | ||
==Example== | ==Example== | ||
Revision as of 19:25, 25 March 2012
Definition
function FindColor(out X, Y: Integer; const Color, XS, YS, XE, YE: Integer): Boolean;
Availability
SCAR Divi 3.00 > Current
Description
This function searches for a given color specified by Color inside of a given search area specified by XS, YS, XE, YE using a scan-line pattern. The search area is given as a set of upper-left (XS, YS) and lower-right (XE, YE) coordinates which are specified relative to the selected client window. If the given search area is invalid (XS > XE or YS > YE), an exception is thrown.
The function returns false if the color was not found, if it was it returns true and the coordinates of the found color in (X, Y). The search will stop after the first instance of the color was found.
Example
var
w, h: Integer;
x, y: Integer;
begin
GetClientDimensions(w, h);
if FindColor(x, y, 0, 0, 0, w - 1, h - 1) then
WriteLn('Found color at ' + IntToStr(x) + ', ' + IntToStr(y));
end.
