home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 18 / amigaformatcd18.iso / mui / mui_developer / autodocs / mui_colorfield.doc < prev    next >
Text File  |  1997-03-10  |  3KB  |  94 lines
  1. TABLE OF CONTENTS
  2.  
  3. Colorfield.mui/Colorfield.mui
  4. Colorfield.mui/MUIA_Colorfield_Blue
  5. Colorfield.mui/MUIA_Colorfield_Green
  6. Colorfield.mui/MUIA_Colorfield_Pen
  7. Colorfield.mui/MUIA_Colorfield_Red
  8. Colorfield.mui/MUIA_Colorfield_RGB
  9. Colorfield.mui/Colorfield.mui
  10.  
  11.     Colorfield class creates a rectangle filled with a specific color,
  12.     useful e.g. within a palette requester. You can change the color
  13.     of the field at any time by setting its RGB attributes.
  14.  
  15.     The field will try to obtain an exclusive pen on the current
  16.     screen. When none is available, it just displays some kind
  17.     of rastered background. Maybe it will get a little more
  18.     intelligent and try to display the color by mixing together
  19.     some other colors, but thats a future topic.
  20.  
  21.     Needless to say that Colorfield only works with Kickstart 3.x
  22.     and above, since lower operating systems don't support pen
  23.     sharing. When using this class with a lower OS, you will
  24.     also get some kind of (boring) raster.
  25. Colorfield.mui/MUIA_Colorfield_Blue
  26.  
  27.     NAME
  28.     MUIA_Colorfield_Blue -- (V4 ) [ISG], ULONG
  29.  
  30.     FUNCTION
  31.     Set or get the 32-bit blue component of the fields color.
  32.     Values range from 0 (no blue) to $ffffffff (full blue).
  33.  
  34.     SEE ALSO
  35.     MUIA_Colorfield_Green, MUIA_Colorfield_Red,
  36.     MUIA_Colorfield_RGB
  37. Colorfield.mui/MUIA_Colorfield_Green
  38.  
  39.     NAME
  40.     MUIA_Colorfield_Green -- (V4 ) [ISG], ULONG
  41.  
  42.     FUNCTION
  43.     Set or get the 32-bit green component of the fields color.
  44.     Values range from 0 (no green) to $ffffffff (full green).
  45.  
  46.     SEE ALSO
  47.     MUIA_Colorfield_Red, MUIA_Colorfield_Blue,
  48.     MUIA_Colorfield_RGB
  49. Colorfield.mui/MUIA_Colorfield_Pen
  50.  
  51.     NAME
  52.     MUIA_Colorfield_Pen -- (V4 ) [..G], ULONG
  53.  
  54.     FUNCTION
  55.     When specified, the colorfield uses exactly this pen instead
  56.     of trying to obtain a new one.
  57.  
  58.     SEE ALSO
  59.     MUIA_Colorfield_RGB
  60. Colorfield.mui/MUIA_Colorfield_Red
  61.  
  62.     NAME
  63.     MUIA_Colorfield_Red -- (V4 ) [ISG], ULONG
  64.  
  65.     FUNCTION
  66.     Set or get the 32-bit red component of the fields color.
  67.     Values range from 0 (no red) to $ffffffff (full red).
  68.  
  69.     SEE ALSO
  70.     MUIA_Colorfield_Green, MUIA_Colorfield_Blue,
  71.     MUIA_Colorfield_RGB
  72. Colorfield.mui/MUIA_Colorfield_RGB
  73.  
  74.     NAME
  75.     MUIA_Colorfield_RGB -- (V4 ) [ISG], ULONG *
  76.  
  77.     FUNCTION
  78.     Set or get the red/green/blue values of a colorfield all at
  79.     once. You pass in / receive a pointer to three longwords
  80.     containing the 32-bit red, green and blue values.
  81.  
  82.     EXAMPLE
  83.  
  84.     ULONG rgb[3] = { 0xa000000,0xdeadbeaf,0x42424242 };
  85.     set(field,MUIA_Colorfield_RGB,rgb);
  86.  
  87.     ULONG *rgb;
  88.     get(field,MUIA_Colorfield_RGB,&rgb);
  89.     printf("red=%08lx green=%08lx blue=%08lx\n",rgb[0],rgb[1],rgb[2]);
  90.  
  91.     SEE ALSO
  92.     MUIA_Colorfield_Green, MUIA_Colorfield_Blue,
  93.     MUIA_Colorfield_Red
  94.