Commit a0ac06f2 authored by Robert Sprowson's avatar Robert Sprowson
Browse files

Documentation enhanced

* Working example of using ChangeFSI as a library added
* Note about not freeing memory when worklimit%=0 added to docs
Retagged as ChangeFSI-1_33.
parent 0fe93c4a
......@@ -200,7 +200,7 @@ of ChangeFSI, defined as the following function:
Where:
A$ the command line argument(s)
A$ the command line argument(s), see examples above
spritearea% address for the output image
or -1 to let ChangeFSI create a spritearea
workspace% address for workspace start, extending up to worklimit%
......@@ -220,6 +220,12 @@ Returns 0 => output completed successfully
It may also produce an error (to whatever error handler is present) if it
fails in a non recoverable manner.
The usefulness of workspace% = -1 and worklimit% = 0 may be limited since any
memory claimed during processing can't be released on completion (as using
the CLEAR keyword would clear the variables of the calling program too),
leading to a memory leak for multiple library calls.
System variables
================
......@@ -232,7 +238,7 @@ or BASIC library use, any input JPEG images must fit in the cache. You can
change the size of this cache by setting the variable ChangeFSI$Cache. For
example:
Set ChangeFSI$Cache 256K
*Set ChangeFSI$Cache 256K
You can also set the system variable ChangeFSI$PCDIndex to change the
PhotoCD resolution that is read. The default value is 3, which corresponds
......
......@@ -283,7 +283,7 @@ JPEG files that fit inside the cache will be read much more quickly. You can
change the size of this cache by setting the variable ChangeFSI$Cache. For
example:
Set ChangeFSI$Cache 256K
*Set ChangeFSI$Cache 256K
You can also set the system variable ChangeFSI$PCDIndex to change the
PhotoCD resolution that is read. The default value is 3, which corresponds
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment