Skip to content

Commit

Permalink
Added missing documentation headers
Browse files Browse the repository at this point in the history
  • Loading branch information
nielsAD committed Jul 14, 2016
1 parent 23a81be commit 8e3497c
Show file tree
Hide file tree
Showing 16 changed files with 1,395 additions and 2 deletions.
88 changes: 86 additions & 2 deletions Doc/sphinx/scriptref/bitmap.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

.. _scriptref-bitmap:

Bitmaps
=======
Bitmap
======

A bitmap in Simba is simply a two dimensional *field of colors*. These colors
can all be the same, or they can be of different colors. Simba features
Expand Down Expand Up @@ -836,3 +836,87 @@ Uses the Bilinear resize method to resize a image matrix (created by BitmapToMat
.. code-block:: pascal
ResizeBilinearMatrix(matrix, 500, 500);
BitmapExists
~~~~~~~~~~~~

.. code-block:: pascal
function BitmapExists(Index: Integer): Boolean
BlurBitmap
~~~~~~~~~~

.. code-block:: pascal
procedure BlurBitmap(const Bitmap, block: Integer)
CalculatePixelShiftTPA
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: pascal
function CalculatePixelShiftTPA(Bitmap1, Bitmap2: Integer; CPoints: TPointArray): Integer
CalculatePixelToleranceTPA
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: pascal
function CalculatePixelToleranceTPA(Bitmap1, Bitmap2: Integer; CPoints: TPointArray; CTS: Integer): Extended
ConvoluteBitmap
~~~~~~~~~~~~~~~

.. code-block:: pascal
function ConvoluteBitmap(Bitmap: Integer; matrix: T2DExtendedArray): Integer
Desaturate
~~~~~~~~~~

.. code-block:: pascal
function Desaturate(Bitmap: Integer): Integer
DrawSystemTextBitmap
~~~~~~~~~~~~~~~~~~~~

.. code-block:: pascal
procedure DrawSystemTextBitmap(const Bitmap: Integer; const Text, FontName: string; const FontSize: Integer; const pnt: TPoint; const Shadow: Boolean; const Color: Integer);
DrawTextBitmap
~~~~~~~~~~~~~~

.. code-block:: pascal
procedure DrawTextBitmap(const Bitmap: Integer; const Text, FontName: string; const pnt: TPoint; const Shadow: Boolean; const Color: Integer)
FindColorsBitmap
~~~~~~~~~~~~~~~~

.. code-block:: pascal
function FindColorsBitmap(Bitmap: Integer; var points: TPointArray; const Color: Integer): Boolean
RectangleBitmapEx
~~~~~~~~~~~~~~~~~

.. code-block:: pascal
procedure RectangleBitmapEx(const Bitmap: Integer; const Box: TBox; const Color: Integer; const Transparency: Extended)
ResizeBitmapEx
~~~~~~~~~~~~~~

.. code-block:: pascal
procedure ResizeBitmapEx(const Bitmap: Integer; const Method: TBitmapResizeMethod; const NewWidth, NewHeight: Integer)
RotateBitmapEx
~~~~~~~~~~~~~~

.. code-block:: pascal
function RotateBitmapEx(Bitmap: Integer; Angle: Single; Expand: Boolean; Smooth: Boolean): Integer
77 changes: 77 additions & 0 deletions Doc/sphinx/scriptref/color conversion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,80 @@ XYZToRGB
..
TODO: Add CIE L*a*b.
CIELabToColor
~~~~~~~~~~~~~

.. code-block:: pascal
function CIELabToColor(L, a, b: Extended): TColor
CIELabToHSL
~~~~~~~~~~~

.. code-block:: pascal
procedure CIELabToHSL(L, a, b: Extended; out HH, SS, LL: Extended)
CIELabToRGB
~~~~~~~~~~~

.. code-block:: pascal
procedure CIELabToRGB(L, a, b: Extended; out rr, gg, bb: Integer)
CIELabtoXYZ
~~~~~~~~~~~

.. code-block:: pascal
procedure CIELabtoXYZ(L, a, b: Extended; out X, Y, Z: Extended)
ColorToCIELab
~~~~~~~~~~~~~

.. code-block:: pascal
procedure ColorToCIELab(Color: Integer; out L, a, b: Extended)
ColorToGray
~~~~~~~~~~~

.. code-block:: pascal
function ColorToGray(const Color: Integer): TColor
HSLToCIELab
~~~~~~~~~~~

.. code-block:: pascal
procedure HSLToCIELab(HH, SS, LL: Extended; out L, a, b: Extended)
HSLToXYZ
~~~~~~~~

.. code-block:: pascal
procedure HSLToXYZ(H, S, L: Extended; out X, Y, Z: Extended)
RGBToCIELab
~~~~~~~~~~~

.. code-block:: pascal
procedure RGBToCIELab(rr, gg, bb: Integer; out L, a, b: Extended)
XYZtoCIELab
~~~~~~~~~~~

.. code-block:: pascal
procedure XYZtoCIELab(X, Y, Z: Extended; out L, a, b: Extended)
XYZToHSL
~~~~~~~~

.. code-block:: pascal
procedure XYZToHSL(X, Y, Z: Extended; out H, S, L: Extended)
63 changes: 63 additions & 0 deletions Doc/sphinx/scriptref/color.rst
Original file line number Diff line number Diff line change
Expand Up @@ -331,3 +331,66 @@ Example getting the modifiers:
Writeln(format('H = %f; S = %f', [H, S]));
end;
FindColoredArea
~~~~~~~~~~~~~~~

.. code-block:: pascal
function FindColoredArea(var x, y: Integer; Color, xs, ys, xe, ye: Integer; MinArea: Integer): Boolean
FindColoredAreaTolerance
~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: pascal
function FindColoredAreaTolerance(var x, y: Integer; Color, xs, ys, xe, ye, MinArea, tol: Integer): Boolean
GetColorsWrap
~~~~~~~~~~~~~

.. code-block:: pascal
procedure GetColorsWrap(Coords: TPointArray; var Colors: TIntegerArray)
GetToleranceSpeed2Modifiers
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: pascal
procedure GetToleranceSpeed2Modifiers(var hMod, sMod: Extended)
GetToleranceSpeed3Modifier
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: pascal
function GetToleranceSpeed3Modifier: Extended
GetToleranceSpeed
~~~~~~~~~~~~~~~~~

.. code-block:: pascal
function GetToleranceSpeed: Integer
SetColorToleranceSpeed
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: pascal
procedure SetColorToleranceSpeed(cts: Integer)
SetToleranceSpeed2Modifiers
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: pascal
procedure SetToleranceSpeed2Modifiers(nHue, nSat: Extended)
SetToleranceSpeed3Modifier
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: pascal
procedure SetToleranceSpeed3Modifier(Modifier: Extended)
84 changes: 84 additions & 0 deletions Doc/sphinx/scriptref/crypto.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@

haval
~~~~~

.. code-block:: pascal
function haval(Data: string): string
md4
~~~

.. code-block:: pascal
function md4(Data: string): string
md5
~~~

.. code-block:: pascal
function md5(Data: string): string
rc2_decrypt
~~~~~~~~~~~

.. code-block:: pascal
procedure rc2_decrypt(const Key: string; const HashType: THashType; var Data: string)
rc2_encrypt
~~~~~~~~~~~

.. code-block:: pascal
procedure rc2_encrypt(const Key: string; const HashType: THashType; var Data: string)
ripemd128
~~~~~~~~~

.. code-block:: pascal
function ripemd128(Data: string): string
ripemd160
~~~~~~~~~

.. code-block:: pascal
function ripemd160(Data: string): string
sha1
~~~~

.. code-block:: pascal
function sha1(Data: string): string
sha256
~~~~~~

.. code-block:: pascal
function sha256(Data: string): string
sha384
~~~~~~

.. code-block:: pascal
function sha384(Data: string): string
sha512
~~~~~~

.. code-block:: pascal
function sha512(Data: string): string
tiger
~~~~~

.. code-block:: pascal
function tiger(Data: string): string
7 changes: 7 additions & 0 deletions Doc/sphinx/scriptref/dtm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -317,3 +317,10 @@ CreateDTMPoint
Create a DTM point.

DTMExists
~~~~~~~~~

.. code-block:: pascal
function DTMExists(index: Integer): Boolean
21 changes: 21 additions & 0 deletions Doc/sphinx/scriptref/files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -279,3 +279,24 @@ DeleteDirectory
function DeleteDirectory(const Dir: String; const Empty: Boolean): Boolean;
Deletes the directory *dir*, if Empty is true will delete the directorys contents else will not.

RenameFile
~~~~~~~~~~

.. code-block:: pascal
function RenameFile(const Oldname, NewName: string): Boolean
UnZipFile
~~~~~~~~~

.. code-block:: pascal
procedure UnZipFile(const FilePath, TargetPath: string)
ZipFiles
~~~~~~~~

.. code-block:: pascal
procedure ZipFiles(const ToFolder: string; const Files: TstringArray)
Loading

0 comments on commit 8e3497c

Please sign in to comment.