moparisthebest/Simba
1
0
Fork 0
mirror of https://github.com/moparisthebest/Simba synced 2024-11-11 20:05:03 -05:00
Code Issues Releases Wiki Activity

Documentation: Some scriptref documentation.

Browse Source
This commit is contained in:
Merlijn Wajer 2011-01-05 15:09:30 +01:00
parent 10e346d2f8
commit 22283e2e5f
3 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Doc/sphinx/scriptref/bitmaps.rst
View File

@ -207,6 +207,7 @@ FastDrawClear
procedure FastDrawClear(bmp : integer; Color : TColor); procedure FastDrawClear(bmp : integer; Color : TColor);
Draw *Color* on every pixel on the bitmap.
FastDrawTransparent FastDrawTransparent
------------------- -------------------
@ -247,6 +248,7 @@ CopyClientToBitmap
procedure CopyClientToBitmap(bmp, xs, ys, xe, ye: Integer); procedure CopyClientToBitmap(bmp, xs, ys, xe, ye: Integer);
Copy client area *xs, ys, xe, ye* to specified bitmap.
BitmapFromClient BitmapFromClient
---------------- ----------------
@ -255,6 +257,7 @@ BitmapFromClient
function BitmapFromClient(const xs, ys, xe, ye: Integer): Integer; function BitmapFromClient(const xs, ys, xe, ye: Integer): Integer;
Create a bitmap from the client. Area specified by *xs, ye, xe, ye*.
SetBitmapName SetBitmapName
------------- -------------
@ -263,6 +266,8 @@ SetBitmapName
procedure SetBitmapName(Bmp : integer; name : string); procedure SetBitmapName(Bmp : integer; name : string);
Assign a name to the bitmap. Mainly for debugging purposes. (It will write the
name of the bitmap if it hasn't been freed.)
FindBitmap FindBitmap
---------- ----------
@ -439,6 +444,8 @@ DrawBitmap
procedure DrawBitmap(Bmp: Integer; Dest: TCanvas; x, y: Integer); procedure DrawBitmap(Bmp: Integer; Dest: TCanvas; x, y: Integer);
Draw the bitmap to a TCanvas.
RectangleBitmap RectangleBitmap
--------------- ---------------

1
Doc/sphinx/scriptref/dtm.rst
View File

@ -295,6 +295,7 @@ PrintDTM
procedure PrintDTM(const DTM : TMDTM); procedure PrintDTM(const DTM : TMDTM);
Print the DTM contents.
MDTMToSDTM MDTMToSDTM
---------- ----------

10
Doc/sphinx/scriptref/files.rst
View File

@ -1,6 +1,11 @@
Working with Files Working with Files
================== ==================
Files in Simba are all *integers*, internal handles for Simba which on their
turn point to operating system files. Functions like CreateFile and OpenFile
return a file handle. You should not forget to close these when you no longer
need them.
CreateFile CreateFile
---------- ----------
@ -8,6 +13,8 @@ CreateFile
function CreateFile(const Path: string): Integer; function CreateFile(const Path: string): Integer;
Create a file with *Path*. Raturns -1 on failure, otherwise returns the handle
to the file.
OpenFile OpenFile
-------- --------
@ -16,6 +23,9 @@ OpenFile
function OpenFile(const Path: string; Shared: Boolean): Integer; function OpenFile(const Path: string; Shared: Boolean): Integer;
Opens file for reading. Opens shared if *Shared* is true.
Returns -1 on failure, otherwise returns the handle to the file.
RewriteFile RewriteFile
----------- -----------