home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Programming / imageioproc.lib / dev / autodocs / imageprocess.autodoc
Encoding:
Text File  |  2001-01-03  |  7.3 KB  |  260 lines
  1. TABLE OF CONTENTS
  2.  
  3. imageprocess.library/--background--
  4. imageprocess.library/--history--
  5. imageprocess.library/DoImageProcessA
  6. imageprocess.library/IMP_AutoGamma
  7. imageprocess.library/IMP_Negative
  8. imageprocess.library/IMP_Scale
  9. imageprocess.library/IMP_SwapColourSpace
  10. imageprocess.library/--background--       imageprocess.library/--background--
  11.  
  12.    PURPOSE
  13.  To allow the processing of image buffers.
  14.  
  15.    COPYRIGHT
  16.  The copyright in this library is owned by Paul Huxham.
  17.  
  18.    DISCLAIMER
  19.  imageprocess.library and its associated files are supposed to enable the
  20.  processing of image buffers. Even though every effort has been made to
  21.  make imageprocess.library as stable and functional as possible, I
  22.  cannot rule out the possibility that imageprocess.library may have bugs
  23.  that have side effects (possibly harmful) on your system.
  24.  
  25.  I hereby reject any liability or responsibility for these or any other
  26.  consequences from the use of imageprocess.library whatsoever. This
  27.  includes, but is not limited to, damage to your equipment, to your data,
  28.  personal injuries, financial loss or any other kinds of side effects.
  29.  
  30.  imageprocess.library is provided as-is. This means I do not guarantee that
  31.  imageprocess.library is fit for any specific purpose and I do not guarantee
  32.  any bug fixes, updates or help during error recovery.
  33.  
  34.    DISTRIBUTION
  35.  imageprocess.library should be distributed at no charge to the end user.
  36.  It may be included on Aminet CDs.
  37.  
  38.  The author retains all rights to the enclosed software. Payment is not
  39.  required for the use of imageprocess.library in public domain software.
  40.  
  41.  For ANY COMMERCIAL APPLICATION using imageprocess.library, contact the
  42.  author for further information concerning distribution.
  43.  
  44.    REQUIREMENTS
  45.  A minimum of Kickstart 3.0, 68020 CPU is required to use
  46.  imageprocess.library.
  47.  
  48.    COMPLIER
  49.  imageproces.library was written and compiled using CED V3.5, SAS/C 6.58 and
  50.  vbcc on an Amiga 4000/060. CyberGuard was used to detect/correct
  51.  programming errors.
  52.  
  53.    BUGS
  54.  Should you find any bugs, please report them so that they can be fixed.
  55.  Likewise any suggestions for improvment of the library should be
  56.  forwarded so that they can be addressed.
  57.  
  58.    THANKYOUS
  59.  Many thanks to
  60.    Dinh Thi Kim Tuyen
  61.      - Who makes the sky blue and the world turn. I love you, forevermore.
  62.  
  63.    Steve Quartly
  64.      - For pushing me into corners I wouldn't normally go, to teach me to
  65.        see things where I would normally give up.
  66.  
  67.    AUTHOR
  68.   You can contact the author via:
  69.     email: paulhuxham@yahoo.com
  70.     www: http://mafeking.scouts.org.au/steeplesoftware
  71.  
  72. imageprocess.library/--history--             imageprocess.library/--history--
  73.  
  74.  V1.0
  75.   > Initial release.
  76.  
  77. imageprocess.library/DoImageProcessA     imageprocess.library/DoImageProcessA
  78.  
  79.    NAME
  80.   DoImageProcessA -- Process image data in memory
  81.   DoImageProcess -- Varargs stub
  82.  
  83.    SYNOPSIS
  84.  err = DoImageProcessA( process, taglist )
  85.                         d0       a0
  86.  
  87.  err = DoImageProcessA( ULONG process, struct TagItem *taglist )
  88.  
  89.  err = DoImageProcess( process, tag1, ... )
  90.  
  91.  err = DoImageProcess( ULONG process, ULONG tag1, ... )
  92.  
  93.    FUNCTION
  94.  Perform an operation on a buffer in memory.
  95.  
  96.  Image process operations available in V1.0:
  97.    IMP_AutoGamma
  98.    IMP_Negative
  99.    IMP_Scale
  100.    IMP_SwapColourSpace
  101.  
  102.   Available tags:
  103.    IMP_SourceImageIOHandle - Pointer to an already allocated and loaded
  104.                              imageio.library buffer. Processes can be
  105.                              performed either inline on the imageio handle
  106.                              or they can produce a new buffer
  107.                              (struct ImageHandle *).
  108.    IMP_SourceBuffer        - Pointer to a buffer in memory (UBYTE *).
  109.    IMP_SourceWidth         - Width of IMP_SourceBuffer.
  110.    IMP_SourceHeight        - Height of IMP_SourceBuffer.
  111.    IMP_SourceColourSpace   - Colourspace of IMP_SourceBuffer.
  112.    IMP_SourceBytesPerPixel - Bytes per pixel of IMP_SourceBuffer.
  113.    IMP_MemoryPool          - Allocate memory on this pool (this tag is NOT
  114.                              permitted with an imagiohandle source buffer)
  115.                              (void *).
  116.    IMP_ProcessInline       - Request the process to be done inline (if
  117.                              possible - not all methods support this eg
  118.                              scaling and swapcolourspace) (BOOL).
  119.  
  120.   Result tags:
  121.    IMP_Buffer           - Buffer (UBYTE **).
  122.    IMP_BufferSize       - Size of memory allocated in bytes (ULONG *).
  123.    IMP_Width            - Buffer width in pixels (ULONG *).
  124.    IMP_Height           - Buffer height in pixels (ULONG *).
  125.    IMP_BytesPerPixel    - Bytes per buffer pixel (LUONG *).
  126.    IMP_ColourSpace      - Type of buffer data (ULONG *).
  127.  
  128.    INPUTS
  129.  process - image process perform (defined above).
  130.  taglist - pointer to a tag list.
  131.  
  132.    RESULT
  133.  err - if non NULL contains an error code. (For a complete list of error
  134.        codes, see imageprocess.h)
  135.  
  136.    WARNING
  137.  If you are not processing inline, YOU are responsible for FreeMem()ing the
  138.  memory allocated by using the tags IMP_Buffer and IMP_BufferSize to obtain
  139.  the size and location of memory allocated for the new buffer.
  140.  
  141.    BUGS
  142.  
  143.    SEE ALSO
  144.  
  145. imageprocess.library/IMP_AutoGamma         imageprocess.library/IMP_AutoGamma
  146.  
  147.    NAME
  148.   IMP_AutoGamma
  149.  
  150.    SYNOPSIS
  151.  
  152.    FUNCTION
  153.  Autocorrect the gamma of a buffer.
  154.  
  155.   Available tags:
  156.    IMP_GammaMode - Either GAMMA_BEST (strict gamma correction - slower) or
  157.                    GAMMA_FAST (not strictly correct, but faster). Defaults
  158.                    to GAMMA_FAST.
  159.    INPUTS
  160.  
  161.    RESULT
  162.  
  163.    NOTES
  164.  Supports rgb and greyscale buffers.
  165.  
  166.    WARNING
  167.  
  168.    BUGS
  169.  
  170.    SEE ALSO
  171.  
  172. imageprocess.library/IMP_Negative           imageprocess.library/IMP_Negative
  173.  
  174.    NAME
  175.   IMP_Negtive
  176.  
  177.    SYNOPSIS
  178.  
  179.    FUNCTION
  180.  Generate a negative of the buffer.
  181.  
  182.    INPUTS
  183.  
  184.    RESULT
  185.  
  186.    NOTES
  187.  Supports rgb and greyscale buffers.
  188.  
  189.    WARNING
  190.  
  191.    BUGS
  192.  
  193.    SEE ALSO
  194.  
  195. imageprocess.library/IMP_Scale                 imageprocess.library/IMP_Scale
  196.  
  197.    NAME
  198.   IMP_Scale
  199.  
  200.    SYNOPSIS
  201.  
  202.    FUNCTION
  203.  Scale a buffer to a new size.
  204.  
  205.   Available tags:
  206.    IMP_ScaleNum            - Numerator for scaling. Defaults to 1 (ULONG).
  207.    IMP_ScaleDenom          - Denomenator for scaling. Defaults to 1 (ULONG).
  208.    IMP_ScaledWidth         - Required width of scaled buffer in pixels
  209.                              (ULONG).
  210.    IMP_ScaledHeight        - Required height of scaled buffer in pixels
  211.                              (ULONG).
  212.    IMP_ScaleMaintainAspect - Maintain aspect ratio when scaling (BOOL).
  213.    IMP_ScaleType - The scaling mode (ULONG).
  214.                     IPSCALE_FAST   - Fast below average quality.
  215.                     IPSCALE_NORMAL - Good quality, medium speed (default).
  216.                     IPSCALE_BEST   - Best quality, slow.
  217.  
  218.    INPUTS
  219.  
  220.    RESULT
  221.  
  222.    NOTES
  223.  Supports rgb and greyscale buffers.
  224.  
  225.    WARNING
  226.  Scaling is only supported inline for imageio handles.
  227.  
  228.    BUGS
  229.  
  230.    SEE ALSO
  231.  
  232. imageprocess.library/IMP_SwapColourSpacegeprocess.library/IMP_SwapColourSpace
  233.  
  234.    NAME
  235.   IMP_SwapColourSpace
  236.  
  237.    SYNOPSIS
  238.  
  239.    FUNCTION
  240.  Change the colour space of a buffer.
  241.  
  242.   Available tags:
  243.    IMP_NewColourSpace - A new colour space, defined in
  244.                         imageio/imagegeneric.h. Not all colourspaces are
  245.                         supported.
  246.    INPUTS
  247.  
  248.    RESULT
  249.  
  250.    NOTES
  251.  Supports rgb, argb and greyscale buffers.
  252.  
  253.    WARNING
  254.  Swapcolourspace is only supported inline for imageio handles.
  255.  
  256.    BUGS
  257.  
  258.    SEE ALSO
  259.  
  260.