Difference between revisions of "FindColorTolEx"

From SCAR Divi Manual
Jump to: navigation, search
(Created page with "right ==Definition== <source lang="scar" lines="false"> function FindColorsTolerance(var Points: TPointArray; Color, xs, ys, xe, ye, Tol: Intege...")
 
m (Freddy moved page FindColorExTol to FindColorTolEx without leaving a redirect)
 
(7 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 FindColorsTolerance(var Points: TPointArray; Color, xs, ys, xe, ye, Tol: Integer): Boolean;
+
function FindColorTolEx(out Points: TPointArray; const Color, XS, YS, XE, YE, Tol: Integer): Boolean;
 
</source>
 
</source>
  
 
==Availability==
 
==Availability==
 
SCAR Divi 3.00 > Current
 
SCAR Divi 3.00 > Current
 +
 +
===Aliases===
 +
*FindColorsTolerance (SCAR Divi 3.00 > 3.34)
  
 
==Description==
 
==Description==
This function searches for a given color specified by '''Color''' within a [[tolerance]] range specified by '''Tol''' 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. The function returns [[false]] if the color was not found, if it was it returns [[true]] and the coordinates of all found instances of the color in the [[TPointArray]] '''Points'''. The search will stop after the first color was found.
+
This function searches for a given color specified by '''Color''' within a [[tolerance]] range specified by '''Tol''' 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 all found instances of the color in the [[TPointArray]] '''Points'''.
 +
 
 +
The active tolerance algorithm can be changed using the [[ColorToleranceSpeed]] function.
  
 
==Example==
 
==Example==
 
<source lang="scar">
 
<source lang="scar">
 
var
 
var
   w, h: Integer;
+
   W, H: Integer;
 
   TPA: TPointArray;
 
   TPA: TPointArray;
  
 
begin
 
begin
   GetClientDimensions(w, h);
+
   GetBoxSize(GetClient.ImageArea, W, H);
   if FindColorsTolerance(TPA, 4, 0, 0, w - 1, h - 1, 5) then
+
   if FindColorTolEx(TPA, 0, 0, 0, W - 1, H - 1, 5) then
 
   begin
 
   begin
 
     WriteLn('Found color ' + IntToStr(Length(TPA)) + ' times');
 
     WriteLn('Found color ' + IntToStr(Length(TPA)) + ' times');
Line 29: Line 36:
  
 
==See Also==
 
==See Also==
*[[FindColors]]
+
*[[FindColorEx]]
*[[FindColorTolerance]]
+
*[[FindColorTol]]
*[[CountColorTolerance]]
+
*[[FindColorsTolEx]]
 +
*[[CountColorTol]]
 
*[[GetColor]]
 
*[[GetColor]]
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Color Functions]]
 
[[Category:Color Functions]]
 +
[[Category:Tolerance Functions]]

Latest revision as of 20:21, 7 August 2012

FindColorsTolerance.gif

Definition

function FindColorTolEx(out Points: TPointArray; const Color, XS, YS, XE, YE, Tol: Integer): Boolean;

Availability

SCAR Divi 3.00 > Current

Aliases

  • FindColorsTolerance (SCAR Divi 3.00 > 3.34)

Description

This function searches for a given color specified by Color within a tolerance range specified by Tol 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 all found instances of the color in the TPointArray Points.

The active tolerance algorithm can be changed using the ColorToleranceSpeed function.

Example

var
  W, H: Integer;
  TPA: TPointArray;

begin
  GetBoxSize(GetClient.ImageArea, W, H);
  if FindColorTolEx(TPA, 0, 0, 0, W - 1, H - 1, 5) then
  begin
    WriteLn('Found color ' + IntToStr(Length(TPA)) + ' times');
    WriteLn('Coordinates: ' + TPAToStr(TPA));
  end;
end.

See Also