home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / dev / mui-2.1.lha / MUI-2.1 / Developer / Autodocs / MUI_Bitmap.doc < prev    next >
Encoding:
Text File  |  1994-07-04  |  4.5 KB  |  145 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_SourceColors
  8. Bitmap.mui/MUIA_Bitmap_Transparent
  9. Bitmap.mui/MUIA_Bitmap_Width
  10. Bitmap.mui/Bitmap.mui
  11.  
  12.     The Bitmap class allows including self-made image data in MUI
  13.     applications. Usually, image class was intended to be used for
  14.     this purpose but unfortunately, its design was not very useful.
  15.  
  16.     In its most simple usage, Bitmap class just display a given
  17.     BitMap. However, you can also tell it to do automatic color
  18.     remapping to match the current display context and you can
  19.     define a transparent color to make the BitMap appear on any
  20.     background.
  21. Bitmap.mui/MUIA_Bitmap_Bitmap
  22.  
  23.     NAME
  24.     MUIA_Bitmap_Bitmap -- (V8) [ISG], struct BitMap *
  25.  
  26.     FUNCTION
  27.     This attribute specifies a pointer to a struct BitMap. Note
  28.     that specifying only a BitMap isn't enough, you have to tell
  29.     MUI about the pixel width and height with MUIA_Bitmap_Width
  30.     and MUIA_Bitmap_Height too.
  31.  
  32.     SEE ALSO
  33.     MUIA_Bitmap_Width, MUIA_Bitmap_Height, MUIA_Bitmap_Transparent,
  34.     MUIA_Bitmap_SourceColors, MUIA_Bitmap_MappingTable
  35. Bitmap.mui/MUIA_Bitmap_Height
  36.  
  37.     NAME
  38.     MUIA_Bitmap_Height -- (V8) [ISG], LONG
  39.  
  40.     FUNCTION
  41.     Define the pixel height of the BitMap.
  42.  
  43.     Note: By default, the bitmap object has a minimum size of
  44.     1 pixel and an unlimited maxium size. If the space is
  45.     too small to hold your BitMap, it will be clipped.
  46.     Usually, you will use MUIA_FixWidth and MUIA_FixHeight
  47.     with BitMap objects to make them always exactly as big as
  48.     the bitmap.
  49.  
  50.     SEE ALSO
  51.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Width, MUIA_Bitmap_Transparent,
  52.     MUIA_Bitmap_SourceColors, MUIA_Bitmap_MappingTable
  53. Bitmap.mui/MUIA_Bitmap_MappingTable
  54.  
  55.     NAME
  56.     MUIA_Bitmap_MappingTable -- (V8) [ISG], UBYTE *
  57.  
  58.     FUNCTION
  59.     Address of an array of UBYTEs, one for each color of the
  60.     source BitMap. MUI will remap the BitMap according to the
  61.     contents of the array.
  62.  
  63.     Since MUI applications usually don't know about their
  64.     display environment, this tag is rarely used. Instead,
  65.     MUIA_Bitmap_SourceColors can be used to allow context
  66.     sensitive color remapping.
  67.  
  68.     SEE ALSO
  69.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Height, MUIA_Bitmap_Width,
  70.     MUIA_Bitmap_Transparent, MUIA_Bitmap_MappingTable
  71. Bitmap.mui/MUIA_Bitmap_SourceColors
  72.  
  73.     NAME
  74.     MUIA_Bitmap_SourceColors -- (V8) [ISG], ULONG *
  75.  
  76.     FUNCTION
  77.     This attribute defines the color palette of the source
  78.     BitMap. If specified, MUI will try to locate these colors
  79.     on the current screen and remap the BitMap accordingly.
  80.  
  81.     You can e.g. specify some great looking 8-color images
  82.     for several buttons of your application and MUI will
  83.     ensure they look fine even on 4-color screens or on
  84.     screens with completely different colors.
  85.  
  86.     When running Kickstart V39 or higher, MUI will use
  87.     ObtainBestPen() to find or create your colors.
  88.     Below V39, a simple color-map search is performed
  89.     to find the best matching entry, but no colors will
  90.     be changed.
  91.  
  92.     The source palette is specified with an array of
  93.     ULONGs, three entries per color, 32bits per gun.
  94.  
  95.     EXAMPLE
  96.     /* MagicWB-like palette for an 8-color image */
  97.  
  98.     const ULONG aboutlogo_colors[24] =
  99.     {
  100.        0xaaaaaaaa,0xaaaaaaaa,0xa0a0a0a0,
  101.        0x00000000,0x00000000,0x00000000,
  102.        0xffffffff,0xffffffff,0xffffffff,
  103.        0x66666666,0x88888888,0xbbbbbbbb,
  104.        0x99999999,0x99999999,0x99999999,
  105.        0xbbbbbbbb,0xbbbbbbbb,0xbbbbbbbb,
  106.        0xbbbbbbbb,0xaaaaaaaa,0x99999999,
  107.        0xffffffff,0xbbbbbbbb,0xaaaaaaaa
  108.     };
  109.  
  110.  
  111.     SEE ALSO
  112.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Height, MUIA_Bitmap_Width,
  113.     MUIA_Bitmap_MappingTable, MUIA_Bitmap_MappingTable
  114. Bitmap.mui/MUIA_Bitmap_Transparent
  115.  
  116.     NAME
  117.     MUIA_Bitmap_Transparent -- (V8) [ISG], LONG
  118.  
  119.     FUNCTION
  120.     If specified, MUI will consider this color of the BitMap
  121.     to be transparent. A mask plane will be generated and
  122.     used for blitting, the background will shine through.
  123.  
  124.     SEE ALSO
  125.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Height, MUIA_Bitmap_Width,
  126.     MUIA_Bitmap_SourceColors, MUIA_Bitmap_MappingTable
  127. Bitmap.mui/MUIA_Bitmap_Width
  128.  
  129.     NAME
  130.     MUIA_Bitmap_Width -- (V8) [ISG], LONG
  131.  
  132.     FUNCTION
  133.     Define the pixel width of the BitMap.
  134.  
  135.     Note: By default, the bitmap object has a minimum size of
  136.     1 pixel and an unlimited maxium size. If the space is
  137.     too small to hold your BitMap, it will be clipped.
  138.     Usually, you will use MUIA_FixWidth and MUIA_FixHeight
  139.     with BitMap objects to make them always exactly as big as
  140.     the bitmap.
  141.  
  142.     SEE ALSO
  143.     MUIA_Bitmap_Bitmap, MUIA_Bitmap_Height, MUIA_Bitmap_Transparent,
  144.     MUIA_Bitmap_SourceColors, MUIA_Bitmap_MappingTable
  145.