home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 114 / af114sub.adf / GadToolsBox3.lzx / GadToolsBox3 / Developers / smartbitmap.image / autodocs / smartbitmap_ic.doc
Encoding:
Text File  |  1998-01-12  |  2.5 KB  |  78 lines
  1. TABLE OF CONTENTS
  2.  
  3. smartbitmap.image/smartbitmap.image
  4. smartbitmap.image/GetSmartBitMapClass
  5. smartbitmap.image/smartbitmap.image       smartbitmap.image/smartbitmap.image
  6.  
  7.    NAME   
  8.         smartbitmap.image -- create image from bitmap (V39)
  9.  
  10.    FUNCTION
  11.         The smartbitmap class provides capability to generate image
  12.         compatible object with a given BitMap structure and palette.
  13.         Source bitmap can be standard amiga bitmap or CyberGraphX bitmap.
  14.         When image object is created, source bitmap is converted to
  15.         destination bitmap which can be planar, chunky or nonpalette (eg.
  16.         hicolor and truecolor).
  17.  
  18.         Palette structure is defined as:
  19.             struct SmartBitMapIRGB
  20.             {
  21.               ULONG I,R,G,B;
  22.             };
  23.  
  24.         I - is allocated pen number, if set to -1 image class will
  25.             allocate it for you.
  26.         R, G, B - 32 bit color values.
  27.  
  28.    TAGS
  29.         IA_Data (struct BitMap *)
  30.         SMBM_BitMap (struct BitMap *) - Pointer to bitmap.
  31.             This tag is required. Applicability is (I). (V39)
  32.  
  33.         SMBM_Border (BOOL) - Draw raised border around image
  34.             Default for this tag is FALSE. Applicability is (I). (V39)
  35.  
  36.         SMBM_SelBorder (BOOL) - Draw selected border around selected
  37.             image.
  38.             Default for this tag is FALSE. Applicability is (I). (V39)
  39.  
  40.         SMBM_Palette (struct SmartBitMapIRGB *) - Palette of bitmap and
  41.             optionally allocated pens. Only required for pallette based
  42.             bitmaps. This tag is mutually exclusive with SMBM_Pens.
  43.             Default for this tag is NULL. Applicability is (I). (V39).
  44.  
  45.         IA_Pens (UWORD *)
  46.         SMBM_Pens (UWORD *) - Table of allocated pens. Only required for
  47.             palette based bitmaps. This tag is mutually exclusive with
  48.             SMBM_Palette.
  49.             Default for this tag is NULL. Applicability is (I). (V39)
  50.  
  51.         SMBM_Screen (struct Screen *) - Screen on which bitmaps will be
  52.             displayed.
  53.             This tag is requires. Applicability is (I). (V39)
  54.  
  55.   SEE ALSO
  56.         intuition/imageclass.h
  57.  
  58. smartbitmap.image/GetSmartBitMapClass   smartbitmap.image/GetSmartBitMapClass
  59.  
  60.    NAME   
  61.         GetSmartBitMapClass -- get public class of smartbitmap (V39)
  62.  
  63.    SYNOPSIS
  64.         smartbitmap_class = GetSmartBitMapClass();
  65.         D0
  66.  
  67.         Class *GetSmartBitMapClass( void );
  68.  
  69.    FUNCTION
  70.         Obtains pointer to smartbitmap.image class for use with
  71.         intuition.library/NewObject().
  72.  
  73.    RESULT
  74.         smartbitmap_class - pointer to smartbitmap class
  75.  
  76.    SEE ALSO
  77.