home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 5 / amigaformatcd05.iso / mui / developer / autodocs / mui_bitmap.doc < prev    next >
Text File  |  1996-08-13  |  5KB  |  181 lines
  1. TABLE OF CONTENTS
  2.  
  3. Bitmap.mui/Bitmap.mui
  4. Bitmap.mui/MUIA_Bitmap_Bitmap
  5. Bitmap.mui/MUIA_Bitmap_Height
  6. Bitmap.mui/MUIA_Bitmap_MappingTable
  7. Bitmap.mui/MUIA_Bitmap_Precision
  8. Bitmap.mui/MUIA_Bitmap_RemappedBitmap
  9. Bitmap.mui/MUIA_Bitmap_SourceColors
  10. Bitmap.mui/MUIA_Bitmap_Transparent
  11. Bitmap.mui/MUIA_Bitmap_UseFriend
  12. Bitmap.mui/MUIA_Bitmap_Width
  13. Bitmap.mui/Bitmap.mui
  14.  
  15.     The Bitmap class allows including self-made image data in MUI
  16.     applications. Usually, image class was intended to be used for
  17.     this purpose but unfortunately, its design was not very useful.
  18.  
  19.     In its most simple usage, Bitmap class just display a given
  20.     BitMap. However, you can also tell it to do automatic color
  21.     remapping to match the current display context and you can
  22.     define a transparent color to make the BitMap appear on any
  23.     background.
  24. Bitmap.mui/MUIA_Bitmap_Bitmap
  25.  
  26.     NAME
  27.     MUIA_Bitmap_Bitmap -- (V8 ) [ISG], struct BitMap *
  28.  
  29.     FUNCTION
  30.     This attribute specifies a pointer to a struct BitMap. Note
  31.     that specifying only a BitMap isn't enough, you have to tell
  32.     MUI about the pixel width and height with MUIA_Bitmap_Width
  33.     and MUIA_Bitmap_Height too.
  34.  
  35.     SEE ALSO
  36.     MUIA_Bitmap_Width, MUIA_Bitmap_Height, MUIA_Bitmap_Transparent,
  37.     MUIA_Bitmap_SourceColors, MUIA_Bitmap_MappingTable
  38. Bitmap.mui/MUIA_Bitmap_Height
  39.  
  40.     NAME
  41.     MUIA_Bitmap_Height -- (V8 ) [ISG], LONG
  42.  
  43.     FUNCTION
  44.     Define the pixel height of the BitMap.
  45.  
  46.     Note: By default, the bitmap object has a minimum size of
  47.     1 pixel and an unlimited maxium size. If the space is
  48.     too small to hold your BitMap, it will be clipped.
  49.     Usually, you will use MUIA_FixWidth and MUIA_FixHeight
  50.     with BitMap objects to make them always exactly as big as
  51.     the bitmap.
  52.  
  53.     SEE ALSO
  54.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Width, MUIA_Bitmap_Transparent,
  55.     MUIA_Bitmap_SourceColors, MUIA_Bitmap_MappingTable
  56. Bitmap.mui/MUIA_Bitmap_MappingTable
  57.  
  58.     NAME
  59.     MUIA_Bitmap_MappingTable -- (V8 ) [ISG], UBYTE *
  60.  
  61.     FUNCTION
  62.     Address of an array of UBYTEs, one for each color of the
  63.     source BitMap. MUI will remap the BitMap according to the
  64.     contents of the array.
  65.  
  66.     Since MUI applications usually don't know about their
  67.     display environment, this tag is rarely used. Instead,
  68.     MUIA_Bitmap_SourceColors can be used to allow context
  69.     sensitive color remapping.
  70.  
  71.     SEE ALSO
  72.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Height, MUIA_Bitmap_Width,
  73.     MUIA_Bitmap_Transparent
  74. Bitmap.mui/MUIA_Bitmap_Precision
  75.  
  76.     NAME
  77.     MUIA_Bitmap_Precision -- (V11) [ISG], LONG
  78.  
  79.     FUNCTION
  80.     Specify the precision value for remapping images. Use
  81.     the same predefined values as for ObtainBestPen() here,
  82.     e.g.
  83.  
  84.     PRECISION_EXACT
  85.     PRECISION_IMAGE
  86.     PRECISION_ICON
  87.     PRECISION_GUI
  88. Bitmap.mui/MUIA_Bitmap_RemappedBitmap
  89.  
  90.     NAME
  91.     MUIA_Bitmap_RemappedBitmap -- (V11) [..G], struct BitMap *
  92.  
  93.     FUNCTION
  94.     Between MUIM_Setup and MUIM_Cleanup, this attribute will
  95.     hold a pointer to the remapped bitmap.
  96. Bitmap.mui/MUIA_Bitmap_SourceColors
  97.  
  98.     NAME
  99.     MUIA_Bitmap_SourceColors -- (V8 ) [ISG], ULONG *
  100.  
  101.     FUNCTION
  102.     This attribute defines the color palette of the source
  103.     BitMap. If specified, MUI will try to locate these colors
  104.     on the current screen and remap the BitMap accordingly.
  105.  
  106.     You can e.g. specify some great looking 8-color images
  107.     for several buttons of your application and MUI will
  108.     ensure they look fine even on 4-color screens or on
  109.     screens with completely different colors.
  110.  
  111.     When running Kickstart V39 or higher, MUI will use
  112.     ObtainBestPen() to find or create your colors.
  113.     Below V39, a simple color-map search is performed
  114.     to find the best matching entry, but no colors will
  115.     be changed.
  116.  
  117.     The source palette is specified with an array of
  118.     ULONGs, three entries per color, 32bits per gun.
  119.  
  120.     EXAMPLE
  121.     /* MagicWB-like palette for an 8-color image */
  122.  
  123.     const ULONG aboutlogo_colors[24] =
  124.     {
  125.        0xaaaaaaaa,0xaaaaaaaa,0xa0a0a0a0,
  126.        0x00000000,0x00000000,0x00000000,
  127.        0xffffffff,0xffffffff,0xffffffff,
  128.        0x66666666,0x88888888,0xbbbbbbbb,
  129.        0x99999999,0x99999999,0x99999999,
  130.        0xbbbbbbbb,0xbbbbbbbb,0xbbbbbbbb,
  131.        0xbbbbbbbb,0xaaaaaaaa,0x99999999,
  132.        0xffffffff,0xbbbbbbbb,0xaaaaaaaa
  133.     };
  134.  
  135.  
  136.     SEE ALSO
  137.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Height, MUIA_Bitmap_Width,
  138.     MUIA_Bitmap_MappingTable, MUIA_Bitmap_MappingTable
  139. Bitmap.mui/MUIA_Bitmap_Transparent
  140.  
  141.     NAME
  142.     MUIA_Bitmap_Transparent -- (V8 ) [ISG], LONG
  143.  
  144.     FUNCTION
  145.     If specified, MUI will consider this color of the BitMap
  146.     to be transparent. A mask plane will be generated and
  147.     used for blitting, the background will shine through.
  148.  
  149.     Currently, only 0 is supported, i.e. only color 0 can
  150.     be made the "shine through" color.
  151.  
  152.     SEE ALSO
  153.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Height, MUIA_Bitmap_Width,
  154.     MUIA_Bitmap_SourceColors, MUIA_Bitmap_MappingTable
  155. Bitmap.mui/MUIA_Bitmap_UseFriend
  156.  
  157.     NAME
  158.     MUIA_Bitmap_UseFriend -- (V11) [I..], BOOL
  159.  
  160.     FUNCTION
  161.     This attribute will make MUI to try to allocate the remapped
  162.     bitmap in a way that allows fastest displaying.
  163. Bitmap.mui/MUIA_Bitmap_Width
  164.  
  165.     NAME
  166.     MUIA_Bitmap_Width -- (V8 ) [ISG], LONG
  167.  
  168.     FUNCTION
  169.     Define the pixel width of the BitMap.
  170.  
  171.     Note: By default, the bitmap object has a minimum size of
  172.     1 pixel and an unlimited maxium size. If the space is
  173.     too small to hold your BitMap, it will be clipped.
  174.     Usually, you will use MUIA_FixWidth and MUIA_FixHeight
  175.     with BitMap objects to make them always exactly as big as
  176.     the bitmap.
  177.  
  178.     SEE ALSO
  179.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Height, MUIA_Bitmap_Transparent,
  180.     MUIA_Bitmap_SourceColors, MUIA_Bitmap_MappingTable
  181.