home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 18 / amigaformatcd18.iso / mui / mui_developer / autodocs / mui_coloradjust.doc < prev    next >
Text File  |  1997-03-10  |  3KB  |  98 lines
  1. TABLE OF CONTENTS
  2.  
  3. Coloradjust.mui/Coloradjust.mui
  4. Coloradjust.mui/MUIA_Coloradjust_Blue
  5. Coloradjust.mui/MUIA_Coloradjust_Green
  6. Coloradjust.mui/MUIA_Coloradjust_ModeID
  7. Coloradjust.mui/MUIA_Coloradjust_Red
  8. Coloradjust.mui/MUIA_Coloradjust_RGB
  9. Coloradjust.mui/Coloradjust.mui
  10.  
  11.     Coloradjust class creates some gadgets that allow adjusting
  12.     a single color. Depending on the operating system, different
  13.     kinds of gadgets are be used. Kickstart 2.x users might only
  14.     receive an RGB slider triple, Kickstart 3.x users could get
  15.     an additional colorwheel if available. However, the outfit
  16.     of this class is not important for you as a programmer.
  17. Coloradjust.mui/MUIA_Coloradjust_Blue
  18.  
  19.     NAME
  20.     MUIA_Coloradjust_Blue -- (V4 ) [ISG], ULONG
  21.  
  22.     FUNCTION
  23.     Set or get the 32-bit blue component of the adjusted color.
  24.     Values range from 0 (no blue) to $ffffffff (full blue).
  25.  
  26.     SEE ALSO
  27.     MUIA_Coloradjust_Green, MUIA_Coloradjust_Red,
  28.     MUIA_Coloradjust_RGB, MUIA_Coloradjust_ModeID
  29. Coloradjust.mui/MUIA_Coloradjust_Green
  30.  
  31.     NAME
  32.     MUIA_Coloradjust_Green -- (V4 ) [ISG], ULONG
  33.  
  34.     FUNCTION
  35.     Set or get the 32-bit green component of the adjusted color.
  36.     Values range from 0 (no green) to $ffffffff (full green).
  37.  
  38.     SEE ALSO
  39.     MUIA_Coloradjust_Red, MUIA_Coloradjust_Blue,
  40.     MUIA_Coloradjust_RGB, MUIA_Coloradjust_ModeID
  41. Coloradjust.mui/MUIA_Coloradjust_ModeID
  42.  
  43.     NAME
  44.     MUIA_Coloradjust_ModeID -- (V4 ) [ISG], ULONG
  45.  
  46.     FUNCTION
  47.     This attribute tells the coloradjust object for which
  48.     screen mode the color shall be adjusted. The object
  49.     queries the display data base for some mode attributes
  50.     (such as supported number of red/green/blue bits) and
  51.     adjusts its display accordingly, giving the user an
  52.     idea of what colors are supported.
  53.  
  54.     Omitting this attribute does not affect the functionality
  55.     of a coloradjust object. The user will still be able to
  56.     adjust a color. However, if you know the ModeID, you
  57.     should supply it.
  58.  
  59.     SEE ALSO
  60.     MUIA_Coloradjust_RGB
  61.  
  62.     EXAMPLE
  63.     set(cadj,MUIA_Coloradjust_ModeID,GetVPModeID(viewport));
  64. Coloradjust.mui/MUIA_Coloradjust_Red
  65.  
  66.     NAME
  67.     MUIA_Coloradjust_Red -- (V4 ) [ISG], ULONG
  68.  
  69.     FUNCTION
  70.     Set or get the 32-bit red component of the adjusted color.
  71.     Values range from 0 (no red) to $ffffffff (full red).
  72.  
  73.     SEE ALSO
  74.     MUIA_Coloradjust_Green, MUIA_Coloradjust_Blue,
  75.     MUIA_Coloradjust_RGB, MUIA_Coloradjust_ModeID
  76. Coloradjust.mui/MUIA_Coloradjust_RGB
  77.  
  78.     NAME
  79.     MUIA_Coloradjust_RGB -- (V4 ) [ISG], ULONG *
  80.  
  81.     FUNCTION
  82.     Set or get the red/green/blue values all at once.
  83.     You pass in / receive a pointer to three longwords
  84.     containing the 32-bit red, green and blue values.
  85.  
  86.     EXAMPLE
  87.  
  88.     ULONG rgb[3] = { 0xa000000,0xdeadbeaf,0x42424242 };
  89.     set(cadj,MUIA_Coloradjust_RGB,rgb);
  90.  
  91.     ULONG *rgb;
  92.     get(cadj,MUIA_Coloradjust_RGB,&rgb);
  93.     printf("red=%08lx green=%08lx blue=%08lx\n",rgb[0],rgb[1],rgb[2]);
  94.  
  95.     SEE ALSO
  96.     MUIA_Coloradjust_Green, MUIA_Coloradjust_Blue,
  97.     MUIA_Coloradjust_Red, MUIA_Coloradjust_ModeID
  98.