home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Basic / wst!blz1.dms / in.adf / docs / rilibdocs.lha / RIGfxLib.doc < prev    next >
Encoding:
Text File  |  1994-09-05  |  6.0 KB  |  169 lines
  1. Library Name:
  2.   rigfxlib #65
  3.  
  4. Authors:
  5.   ReflectiveImages, 17 Mayles Road, Southsea, Portsmouth, Hampshire, UK PO4 8NP
  6.  
  7. OverView:
  8.   Another Reflective Images Library, hmmm, I just fixed up the palette
  9.   library heaps but thought I better include this incase....
  10.  
  11. Authors Docs:
  12.  
  13. GFX Library v0.1
  14. ================
  15.  
  16. By Stephen McNamara and Steve Matty
  17. (c)1994 Reflective Images
  18.  
  19. This library contains commands for the control of palette objects inside
  20. Blitz2.  These are just simple commands that allow either interrogation of
  21. the palette objects are modifications to the colour values contained in
  22. them.  After changing the palette with these commands, you'll have to do
  23. either a USE PALETTE or DISPLAYPALETTE (whichever is applicable to what
  24. you're doing) to make the changes come into effect on your screen.
  25.  
  26. Please feel free to critisise (or praise!) this library, send me anything
  27. you want to say about it at:
  28.  
  29.   SIS3149@SISVAX.PORT.AC.UK
  30.     or
  31.   SIS3147@SISVAX.PORT.AC.UK
  32.  
  33. Or send us anything you've written........
  34.  
  35.  
  36. Command list:
  37.       PaletteInfo palette#
  38.       r.w=PalRed (Colour#)
  39.       g.w=PalGreen (Colour#)
  40.       b.w=PalBlue (Colour#)
  41.       r.w=AGAPalRed (Colour#)
  42.       g.w=AGAPalGreen (Colour#)
  43.       b.w=AGAPalBlue (Colour#)
  44.       PalAdjust dest_palette#,ration.q[,start_col,end_col]
  45.       FillPalette palette#,r,g,b[start_col,end_col]
  46.       AGAFillPalette palette#,r,g,b[start_col,end_col]
  47.  
  48. Statement: PaletteInfo
  49. ------------------------------------------------------------------------
  50. Modes : Amiga/Blitz
  51. Syntax: PaletteInfo Palette#
  52.  
  53.   This command is used to specify the palette object that all palette
  54. interrogations should look at.  The majority of the commands use this
  55. palette object as the source for their data, e.g. PalRed(1) will look at
  56. the red value of colour 1 of the palette last used in a PaletteInfo
  57. command.
  58.  
  59.  
  60. Function: PalRed
  61. ------------------------------------------------------------------------
  62. Modes : Amiga/Blitz
  63. Syntax: r.w=PalRed (Colour#)
  64.  
  65.   This command is used to get the red value of colour number Colour#.  You
  66. should use the PaletteInfo command to specify what palette this command
  67. takes its information from.
  68.   The value returned will be from 0 to 15
  69.  
  70. Function: PalGreen
  71. ------------------------------------------------------------------------
  72. Modes : Amiga/Blitz
  73. Syntax: g.w=PalGreen (Colour#)
  74.  
  75.   This command is used to get the green value of colour number Colour#.
  76. You should use the PaletteInfo command to specify what palette this command
  77. takes its information from.
  78.   The value returned will be from 0 to 15
  79.  
  80. Function: PalBlue
  81. ------------------------------------------------------------------------
  82. Modes : Amiga/Blitz
  83. Syntax: b.w=PalBlue (Colour#)
  84.  
  85.   This command is used to get the blue value of colour number Colour#.  You
  86. should use the PaletteInfo command to specify what palette this command
  87. takes its information from.
  88.   The value returned will be from 0 to 15
  89.  
  90. Function: AGAPalRed
  91. ------------------------------------------------------------------------
  92. Modes : Amiga/Blitz
  93. Syntax: r.w=AGAPalRed (Colour#)
  94.  
  95.   This command is used to get the red value of colour number Colour#.  You
  96. should use the PaletteInfo command to specify what palette this command
  97. takes its information from.
  98.   The value returned will be from 0 to 255, this number of shades, though,
  99. can only be displayed on an AGA machine.
  100.  
  101. Function: AGAPalGreen
  102. ------------------------------------------------------------------------
  103. Modes : Amiga/Blitz
  104. Syntax: g.w=AGAPalGreen (Colour#)
  105.  
  106.   This command is used to get the green value of colour number Colour#.
  107. You should use the PaletteInfo command to specify what palette this command
  108. takes its information from.
  109.   The value returned will be from 0 to 255, this number of shades, though,
  110. can only be displayed on an AGA machine.
  111.  
  112. Function: AGAPalBlue
  113. ------------------------------------------------------------------------
  114. Modes : Amiga/Blitz
  115. Syntax: b.w=AGAPalBlue (Colour#)
  116.  
  117.   This command is used to get the blue value of colour number Colour#.  You
  118. should use the PaletteInfo command to specify what palette this command
  119. takes its information from.
  120.   The value returned will be from 0 to 255, this number of shades, though,
  121. can only be displayed on an AGA machine.
  122.  
  123.  
  124. Statement: PalAdjust
  125. ------------------------------------------------------------------------
  126. Modes : Amiga/Blitz
  127. Syntax: PalAdjust dest_palette#,ration.q[,start_col,end_col]
  128.  
  129.   This command is used to multiple all the colours, or a range of colours,
  130. in a palette object, by a ratio.  The dest_palette# arguement is used to
  131. give a destination for the adjusted colour information.  This destination
  132. should be a pre-reserved palette and should be AT LEAST as big and the
  133. source palette.  The source palette is taken as being the palette last used
  134. in the PaletteInfo command.
  135.   The ratio should be given as either a quick value or a float and should
  136. be below one for a fade or above to lighten a palette.  If you give a ratio
  137. of 1 then a palette copy will occur.
  138.   The optional start and end parameters let you specify the range of
  139. colours to adjust.  Only this range of colours, though, will be adjusted
  140. and stored in the destination palette.
  141.  
  142.  
  143. Statement: FillPalette
  144. ------------------------------------------------------------------------
  145. Modes : Amiga/Blitz
  146. Syntax: FillPalette palette#,r,g,b[start_col,end_col]
  147.  
  148.   This command lets you fill a given palette object with specific r,g,b
  149. values.  The values given should be between 0 to and 15.  Optionally, you
  150. can give start and end colour numbers to set a range for the fill.  You
  151. should be careful, though, because when you specify a range, no checking is
  152. done (at the moment) to make sure that you don't exceed the colour limit of
  153. the palette.
  154.   You should note that this command does not work on the palette last
  155. PaletteInfo'ed.
  156.  
  157.  
  158. Statement: AGAFillPalette
  159. ------------------------------------------------------------------------
  160. Modes : Amiga/Blitz
  161. Syntax: AGAFillPalette palette#,r,g,b[start_col,end_col]
  162.  
  163.   This command is identical to FillPalette except that it lets you specify
  164. AGA shade values for the r,g,b parameters.
  165.   See FillPalette for more information.
  166.  
  167.  
  168. >> END
  169.