home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / mui / mui_developer / autodocs / mui_bodychunk.doc < prev    next >
Text File  |  1997-03-10  |  3KB  |  84 lines
  1. TABLE OF CONTENTS
  2.  
  3. Bodychunk.mui/Bodychunk.mui
  4. Bodychunk.mui/MUIA_Bodychunk_Body
  5. Bodychunk.mui/MUIA_Bodychunk_Compression
  6. Bodychunk.mui/MUIA_Bodychunk_Depth
  7. Bodychunk.mui/MUIA_Bodychunk_Masking
  8. Bodychunk.mui/Bodychunk.mui
  9.  
  10.     Big and colorful images (e.g. About-Logos) usually take lots
  11.     of space when stored in a traditional BitMap structure. To
  12.     save memory, you can decide to have the picture compressed
  13.     in your code and use the Bodychunk class instead of the
  14.     Bitmap class for displaying. MUI will then automatically
  15.     decompress your image when its about to appear in a
  16.     window.
  17.  
  18.     Since Bodychunk class is a subclass of Bitmap class, you can
  19.     of course use all the Bitmaps remapping and transparency
  20.     features.
  21. Bodychunk.mui/MUIA_Bodychunk_Body
  22.  
  23.     NAME
  24.     MUIA_Bodychunk_Body -- (V8 ) [ISG], UBYTE *
  25.  
  26.     FUNCTION
  27.     Specify a pointer to the BODY data of your picture. This BODY
  28.     data must follow normal IFF/ILBM conventions.
  29.  
  30.     You have to supply MUIA_Bitmap_Width, MUIA_Bitmap_Height and
  31.     MUIA_Bodychunk_Depth to describe the contents of the BODY
  32.     data, otherwise MUI will fail to decompress it.
  33.  
  34.     Body data may be shared between different Bodychunk objects
  35.     and does not need to be in chip ram.
  36.  
  37.     SEE ALSO
  38.     MUIA_Bodychunk_Depth, MUIA_Bodychunk_Compression,
  39.     MUIA_Bodychunk_Masking
  40. Bodychunk.mui/MUIA_Bodychunk_Compression
  41.  
  42.     NAME
  43.     MUIA_Bodychunk_Compression -- (V8 ) [ISG], UBYTE
  44.  
  45.     FUNCTION
  46.     MUI is able to uncompress byte&run compressed BODY chunks
  47.     automatically. If your data is compressed, you must
  48.     supply a value of cmpByteRun1 (==1) for this tag. Other
  49.     compression techniques are not supported.
  50.  
  51.     Omitting this tag or setting it to 0 indicates that the
  52.     BODY data is uncompressed. Using the Bodychunk class
  53.     doesn't make much sense in this case since its main
  54.     purpose is to save memory for big images.
  55.  
  56.     SEE ALSO
  57.     MUIA_Bodychunk_Masking, MUIA_Bodychunk_Body
  58. Bodychunk.mui/MUIA_Bodychunk_Depth
  59.  
  60.     NAME
  61.     MUIA_Bodychunk_Depth -- (V8 ) [ISG], LONG
  62.  
  63.     FUNCTION
  64.     Specify the depth of your picture here. This tag is
  65.     required for correct BODY chunk parsing. Also remember
  66.     to use MUIA_Bodychunk_Masking if your BODY data contains
  67.     a masking bitplane.
  68.  
  69.     SEE ALSO
  70.     MUIA_Bodychunk_Body, MUIA_Bodychunk_Masking
  71. Bodychunk.mui/MUIA_Bodychunk_Masking
  72.  
  73.     NAME
  74.     MUIA_Bodychunk_Masking -- (V8 ) [ISG], UBYTE
  75.  
  76.     FUNCTION
  77.     You must indicate if your BODY data contains a masking
  78.     plane. Currently, MUI does not use this masking plane
  79.     for any purpose, but this attribute is required to
  80.     allow correct parsing of the BODY data.
  81.  
  82.     SEE ALSO
  83.     MUIA_Bodychunk_Body, MUIA_Bodychunk_Compression
  84.