Differences

This shows you the differences between two versions of the page.

--- imagesearch [2018/05/10 14:40] – thekojukinator
+++ imagesearch [2018/05/10 15:09] (current) – thekojukinator
@@ Line 1: / Line 1: @@
-====== Image Search with AutoIt ======
+====== ImageSearch with AutoIt ======
 ===== Overview =====
-I came across the need to be able to find something on the screen based on a reference image in my [[https://www.autoitscript.com|AutoIt]] scripts. However, this is not an available feature of //AutoIt//. There are functions available for checking individual pixels, but not images.
+I needed the ability for [[https://www.autoitscript.com|AutoIt]] to find something on the screen matching a reference image. Unfortunately, this is not an available built-in feature. There are functions available for checking individual pixels, but no way to match groups of pixels or images.
-I found a solution in [[https://www.autoitscript.com/forum/topic/148005-imagesearch-usage-explanation/?page=4|this thread]]. The key is the [[https://www.autohotkey.com/docs/commands/ImageSearch.htm|AutoHotkey ImageSearch]] function. Someone extracted the //ImageSearch// code from //AutoHotkey//, packed it up in to convenient DLLs, and put together a //UDF// ((//User Defined Functions// in AutoIt, usually collected in to a .au3 library.)) library that acts as a wrapper.
+I found a solution in [[https://www.autoitscript.com/forum/topic/148005-imagesearch-usage-explanation/?page=4|this thread]]. The key is the [[https://www.autohotkey.com/docs/commands/ImageSearch.htm|AutoHotkey ImageSearch]] function. Someone extracted the **ImageSearch** code from //AutoHotkey//, packed it up in to convenient DLLs, and put together a **UDF** library that acts as a wrapper.
-I took the //UDF// library and made the following improvements to it:
+I took the **UDF** library and made the following improvements to it:
-  * Updated relevant functions to return an array of //[x,y]// coordinates on success, and //False// on failure. Original search functions returned //True/False// success status, while coordinate results were stored in external variables passed in by reference.
+  * Updated relevant functions to return an array of ''[x,y]'' coordinates on success, and ''False'' on failure. Original search functions returned ''True/False'' success status, while coordinate results were stored in external variables passed in by reference.
   * Updated relevant functions with an extra parameter for a window handle, making it possible to limit the search area to the boundaries of a specified window.
-  * Added the ability to handle multi-monitor desktops by re-defining desktop boundaries in to new //Global// variables //$desktopLeft//, //$desktopTop//, //$desktopRight//, //$desktopBottom//, //$desktopWidth//, and //$desktopHeight//.
+  * Added the ability to handle multi-monitor desktops by re-defining desktop boundaries in to new global variables ''desktopLeft'', ''desktopTop'', ''desktopRight'', ''desktopBottom'', ''desktopWidth'', and ''desktopHeight''.
-===== Syntax =====
+===== Example =====
-The best intro to the syntax is in my example code...
 <code autoit>
-; includes
+; Include the ImageSearch library
-#include <ImageSearch.au3>	; for _ImageSearch, _ImageSearchArea, _WaitForImageSearch, _WaitForImagesSearch
+#include ".\ImageSearch\ImageSearch.au3"
-; Ref: https://www.autoitscript.com/autoit3/docs/functions/AutoItSetOption.htm
-; Enforce pre-declaration of variables, helps develop good coding habits
-AutoItSetOption("MustDeclareVars", 1)
-; Set the mouse coordinate mode to screen absolute
-;	0 = relative to active window
-;	1 = absolute screen
-;	2 = relative to client area of active window
-AutoItSetOption("MouseCoordMode", 1)
 ; This will be the target image file to search for
-Local $target = ".\ImageSearch_target.png"
+Local $target = "DemoTarget.png"
 ; Declare an init a variable to hold the search result
-Local $result = 0
+Local $result = False
-; EXAMPLE 1
-; Find the image in a specified area, and move the mouse to its location
-$result = _ImageSearchArea($target, 1, $desktopLeft, $desktopTop, $desktopWidth, $desktopHeight, 0)
-If IsArray($result) Then MouseMove($result[0], $result[1])
-; EXAMPLE 2
 ; Find the image across the entire desktop
 $result = _ImageSearch($target, 1)
+; If found, move the mouse to it
 If IsArray($result) Then MouseMove($result[0], $result[1])
-; The above examples accomplish the same goal, in fact _ImageSearch actually
-; calls _ImageSearchArea with predetermined parameters
 </code>
-More in-depth function documentation is included in the comments of //ImageSearch.au3//.
 ===== Download =====