Commodore‎ > ‎BASIC‎ > ‎Keywords‎ > ‎

RCLR

Keyword Abbreviation Token (hex) Version(s) Classification
RCLR R{Shift+C} CD 3.5,7.0 Function
DOPEN D{Shift+O} CD 4.x Command and Statement

  Syntax  
RCLR ( colorSource )
 
Parameters Type Legal Value(s) Note(s)
colorSource Integer
  1. background (bitmap & 40-column text)
  2. bitmap foreground
  3. bitmap multi-color 1
  4. bitmap multi-color 2
  5. 40-column border
  6. active text*
  7. 80-column background*
* C128 only
 
Returns Type Value(s) Note(s)
chipColor Integer
1 ~ 16
 
  Purpose  
Return a chipColor assigned to a graphic screen element.
 
  Remarks  
The RCLR function is a partial complement to COLOR.  It returns the chipColor that has been assigned to a colorSource.  On the TED series (BASIC v3.5), another partial complement to COLOR is available, RLUM.  See COLOR for a list of colors and their assigned numbers.
 
The text color can be changed by printing special "control codes" with CHR$ (or some reverse-font characters in text strings).  Only BASAIC v7.0, however, allows you to get the current text color with RCLR.  On other machines, you have to PEEK a secret variable, "Text Attribute".  The C128 has two text screens, but RCLR can only give the text color of the active text editor.  So to get the "other" screen's text color, you would have to use GRAPHIC (or print ESC X) to switch the active text editor before using this function (and then you may need to switch back to the original text editor).  What a kludge!
 
If colorSource is omitted or is not a valid expression, SYNTAX ERROR occurs.  If colorSource is a string, TYPE MISMATCH ERROR occurs; you can use VAL to make a string numeric.  Otherwise the colorSource is converted with INT.  If the result is not a LegalValue (see table above) then ILLEGAL QUANTITY ERROR occurs.
 
Examples (from C128 in 80-column text mode, default values):
PRINT RCLR("0")
 
?TYPE MISMATCH ERROR 
READY.
PRINT RCLR(0) : REM 40-column background
 12                  dark gray

READY.
PRINT RCLR(1) : REM bitmap background
 14                  light green

READY.
PRINT RCLR(2) : REM bitmap multi-color 1
 2                   white

READY.
PRINT RCLR(3) : REM bitmap multi-color 2
 3                   red

READY.
PRINT RCLR(4) : REM 40-column border
 14                  light green

READY.
PRINT RCLR(5) : REM active text color (80 columns)
 4                   cyan

READY.
PRINT RCLR(6) : REM 80-column background
 1                   black

READY.
PRINT RGR(7)
 
?ILLEGAL QUANTITY ERROR 
READY.
 
  Compare With  
 
  Contrast With  
 
  See Also  

© H2Obsession, 2014
Comments