Difference between revisions of "FindColor"
From SCAR Divi Manual
| (8 intermediate revisions by the same user not shown) | |||
| 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 | + | This function searches for a given color specified by '''Color''' 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== | ||
<source lang="scar"> | <source lang="scar"> | ||
var | var | ||
| − | + | W, H: Integer; | |
| − | + | X, Y: Integer; | |
| + | |||
begin | begin | ||
| − | + | GetBoxSize(GetClient.ImageArea, W, H); | |
| − | if FindColor( | + | if FindColor(X, Y, 0, 0, 0, W - 1, H - 1) then |
| − | WriteLn('Found color at ' + IntToStr( | + | WriteLn('Found color at ' + IntToStr(X) + ', ' + IntToStr(Y)); |
end. | end. | ||
</source> | </source> | ||
==See Also== | ==See Also== | ||
| − | *[[ | + | *[[FindColorTol]] |
| + | *[[FindColorEx]] | ||
*[[FindColorSpiral]] | *[[FindColorSpiral]] | ||
| + | *[[CountColor]] | ||
| + | *[[FindColors]] | ||
*[[GetColor]] | *[[GetColor]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Color Functions]] | [[Category:Color Functions]] | ||
Latest revision as of 20:19, 7 August 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 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
GetBoxSize(GetClient.ImageArea, W, H);
if FindColor(X, Y, 0, 0, 0, W - 1, H - 1) then
WriteLn('Found color at ' + IntToStr(X) + ', ' + IntToStr(Y));
end.
