1
0
mirror of https://github.com/moparisthebest/Simba synced 2024-11-28 03:52:23 -05:00

simbadoc: Targets and Windows. (50% done)

This commit is contained in:
Merlijn Wajer 2010-10-02 01:58:13 +02:00
parent 56f4895be3
commit d12b99ce75

View File

@ -12,6 +12,25 @@ Freeze
function Freeze: boolean; function Freeze: boolean;
If you call Freeze, the data that is *currently* currently in the client
is stored into memory. Simba will then target this memory for all further
finding operations; until *Unfreeze* is called. This can dramatically increase
speed if you don't care if the image doesn't change. It can be even more
important if you don't *want* the image to change; if you want to analyze a
specific frame.
Use like:
.. code-block:: pascal
Freeze;
if findcolors(...) then
...
Unfreeze
Make sure you never forget to call Unfreeze!
Unfreeze Unfreeze
-------- --------
@ -19,6 +38,8 @@ Unfreeze
function Unfreeze: boolean; function Unfreeze: boolean;
Unfreeze the client data and restore the original client. See *Freeze* for more
details.
GetClientDimensions GetClientDimensions
------------------- -------------------
@ -27,6 +48,8 @@ GetClientDimensions
procedure GetClientDimensions(var w, h:integer); procedure GetClientDimensions(var w, h:integer);
Return the size of the client in *w* and *h*.
SetTargetBitmap SetTargetBitmap
--------------- ---------------
@ -35,6 +58,8 @@ SetTargetBitmap
function SetTargetBitmap(Bitmap : integer): integer; function SetTargetBitmap(Bitmap : integer): integer;
Set a bitmap as target / client. (It must be loaded by Simba)
SetTargetArray SetTargetArray
-------------- --------------
@ -43,6 +68,10 @@ SetTargetArray
function SetTargetArray(P: Integer; w, h: integer): integer; function SetTargetArray(P: Integer; w, h: integer): integer;
Set a target array as client data. This is generally not something you'd
want to call yourself. It is mainly included for external components to allow
Simba to efficiently target its memory. See the SMART source on how to do this.
SetEIOSTarget SetEIOSTarget
------------- -------------
@ -115,6 +144,7 @@ SetDesktopAsClient
procedure SetDesktopAsClient; procedure SetDesktopAsClient;
Set the default desktop as client.
ActivateClient ActivateClient
-------------- --------------
@ -123,6 +153,8 @@ ActivateClient
procedure ActivateClient; procedure ActivateClient;
Set the current target as active for key input.
IsTargetValid IsTargetValid
------------- -------------
@ -131,4 +163,5 @@ IsTargetValid
function IsTargetValid: boolean; function IsTargetValid: boolean;
Returns true if the current target is valid.