$COLOR: Difference between revisions

From QB64 Phoenix Edition Wiki
Jump to navigation Jump to search
m (Protected "$COLOR" ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite)))
No edit summary
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[$COLOR]] is a metacommand that adds named color [[CONST|constants]] in a program.
'''$COLOR''' is a metacommand that adds named color constants into a program, which then can be used instead of hardcoded literal color values.




{{PageSyntax}}
{{PageSyntax}}
: [[$COLOR]]:0
: [[$COLOR]]''':'''{0|32}
: [[$COLOR]]:32
 
 
{{PageParameters}}
* The one and only parameter is a literal number designating either to include [[SCREEN|SCREEN 0]] based color indexes, or full [[_RGB32]] color values with full (opaque) alpha.




{{PageDescription}}
{{PageDescription}}
* [[$COLOR]]:0 adds [[CONST|constants]] for colors 0-15. The actual constant names can be found in the file '''source/utilities/color0.bi'''.
* '''$COLOR:0''' adds constants for the colors 0-15 available in '''SCREEN 0''', these do also match for the first 16 colors on 8-Bit (256 colors) graphic screens as long as they are not changed using [[PALETTE]] or [[_PALETTECOLOR]]. For the actual constant names see [https://qb64phoenix.com/qb64wiki/resources/Color0.html $COLOR:0 Name Table].
* [[$COLOR]]:32 adds [[CONST|constants]] for 32-bit colors, similar to HTML color names. The actual constant names can be found in the file '''source/utilities/color32.bi'''.
* '''$COLOR:32''' adds constants for full 32-Bit color values as used on 32-Bit screens created via [[_NEWIMAGE]], similar to HTML color names. For the actual constant names see [https://qb64phoenix.com/qb64wiki/resources/Color32.html $COLOR:32 Name Table].
* [[$COLOR]] is a shorthand to manually using [[$INCLUDE]] pointing to the files listed above.
* Prior to QB64-PE v0.5.0, '''$COLOR''' was not compatible with [[$NOPREFIX]].
* Prior to QBPE v0.5, [[$COLOR]] was not compatible with [[$NOPREFIX]].
* Since QB64-PE v0.5.0, '''$COLOR''' can now be used with [[$NOPREFIX]], with a few notable differences to three conflicting colors -- Red, Green, Blue.
* Since QBPE v0.5, [[$COLOR]] can now be used with [[$NOPREFIX]], with a few notable differences to three conflicting colors -- Red, Green, Blue.


:Red would conflict with [[_RED]], Green would conflict with [[_GREEN]], and Blue would conflict with [[_BLUE]], once the underscore was removed from those commands with [[$NOPREFIX]].
:Red would conflict with [[_RED]], Green would conflict with [[_GREEN]], and Blue would conflict with [[_BLUE]], once the underscore was removed from those commands with [[$NOPREFIX]].
: 
:
:To prevent these conflicts, the [[COLOR]] values have had '''NP_''' prepended to the front of them, to distinguish them from the non-prefixed command names.  All other color names remain the same, with only the three colors in conflict having to use '''NP_''' (for '''N'''o '''P'''refix) in front of them.
:To prevent these conflicts, the [[COLOR]] values have had '''NP_''' prepended to the front of them, to distinguish them from the non-prefixed command names.  All other color names remain the same, with only the three colors in conflict having to use '''NP_''' (for '''N'''o '''P'''refix) in front of them.
:
:Note that [[$NOPREFIX]] was {{Text|'''deprecated'''|red}} in '''QB64-PE v4.0.0''' and so also the '''NP_''' color names are gone.


{{PageExamples}}
{{PageExamples}}
'''Example 1:''' ''Adding named color constants for SCREEN 0:''
;Example 1:Adding named color constants for SCREEN 0.
{{CodeStart}}
{{CodeStart}}
{{Cl|$COLOR}}:0
{{Cm|$COLOR}}:{{Text|0|#F580B1}}
 
{{Cl|COLOR}} BrightWhite, Red
{{Cl|COLOR}} BrightWhite, Red
{{Cl|PRINT}} "Bright white on red."
{{Cl|PRINT}} {{Text|<nowiki>"Bright white on red."</nowiki>|#FFB100}}
{{CodeEnd}}
{{CodeEnd}}
{{OutputStartBG4}}
{{OutputStartBG0}}
{{Text|Bright white on red.|#fcfcfc}}
{{Ot|Bright white on red.|#ffffff|#aa0000}}
{{OutputEnd}}
{{OutputEnd}}


----


'''Example 2:''' ''Adding named color constants for 32-bit modes:''
;Example 2:Adding named color constants for 32-bit modes.
{{CodeStart}}
{{CodeStart}}
{{Cl|SCREEN}} {{Cl|_NEWIMAGE}}(640, 400, 32)
{{Cl|SCREEN}} {{Cl|_NEWIMAGE}}({{Text|640|#F580B1}}, {{Text|400|#F580B1}}, {{Text|32|#F580B1}})
{{Cl|$COLOR}}:32
{{Cm|$COLOR}}:{{Text|32|#F580B1}}
 
{{Cl|COLOR}} CrayolaGold, DarkCyan
{{Cl|COLOR}} CrayolaGold, DarkCyan
{{Cl|PRINT}} "CrayolaGold on DarkCyan."
{{Cl|PRINT}} {{Text|<nowiki>"CrayolaGold on DarkCyan."</nowiki>|#FFB100}}
{{CodeEnd}}
{{CodeEnd}}
{{OutputStartBG0}}
{{Ot|CrayolaGold on DarkCyan.|#E7C697|#008B8B}}
{{OutputEnd}}


'''Example 3:''' ''Adding named color constants for 32-bit modes (with $NOPREFIX in effect):''
----
 
;Example 3:Adding named color constants for 32-bit modes (with $NOPREFIX in effect).
{{CodeStart}}
{{CodeStart}}
{{Cl|SCREEN}} {{Cl|_NEWIMAGE}}(640, 400, 32)
{{Cm|$NOPREFIX}}
{{Cl|$COLOR}}:32
 
{{Cl|$NOPREFIX}}
{{Cl|SCREEN}} {{Cl|NEWIMAGE}}({{Text|640|#F580B1}}, {{Text|400|#F580B1}}, {{Text|32|#F580B1}})
{{Cl|COLOR}} NP_Red, White 'notice the NP_ in front of Red?
{{Cm|$COLOR}}:{{Text|32|#F580B1}}
'This is to distinguish the color from the command with $NOPREFIX.
 
{{Cl|PRINT}} "Red on White."
{{Cl|COLOR}} NP_Red, White {{Text|<nowiki>'notice the NP_ in front of Red?</nowiki>|#919191}}
{{Text|<nowiki>'This is to distinguish the color from the command with $NOPREFIX.</nowiki>|#919191}}
{{Cl|PRINT}} {{Text|<nowiki>"Red on White."</nowiki>|#FFB100}}
{{CodeEnd}}
{{CodeEnd}}
{{OutputStartBG0}}
{{Ot|Red on White.|#ff0000|#ffffff}}
{{OutputEnd}}


{{PageSeeAlso}}
{{PageSeeAlso}}
* [[COLOR]], [[SCREEN]]  
* [[COLOR]]
* [[_NEWIMAGE]], [[$INCLUDE]]
* [[SCREEN]], [[_NEWIMAGE]]
* [[Metacommand]]
* [[Metacommand]]
* [https://qb64phoenix.com/qb64wiki/resources/Color0.html $COLOR:0 Name Table]
* [https://qb64phoenix.com/qb64wiki/resources/Color32.html $COLOR:32 Name Table]




{{PageNavigation}}
{{PageNavigation}}

Latest revision as of 20:45, 21 November 2024

$COLOR is a metacommand that adds named color constants into a program, which then can be used instead of hardcoded literal color values.


Syntax

$COLOR:{0|32}


Parameters

  • The one and only parameter is a literal number designating either to include SCREEN 0 based color indexes, or full _RGB32 color values with full (opaque) alpha.


Description

  • $COLOR:0 adds constants for the colors 0-15 available in SCREEN 0, these do also match for the first 16 colors on 8-Bit (256 colors) graphic screens as long as they are not changed using PALETTE or _PALETTECOLOR. For the actual constant names see $COLOR:0 Name Table.
  • $COLOR:32 adds constants for full 32-Bit color values as used on 32-Bit screens created via _NEWIMAGE, similar to HTML color names. For the actual constant names see $COLOR:32 Name Table.
  • Prior to QB64-PE v0.5.0, $COLOR was not compatible with $NOPREFIX.
  • Since QB64-PE v0.5.0, $COLOR can now be used with $NOPREFIX, with a few notable differences to three conflicting colors -- Red, Green, Blue.
Red would conflict with _RED, Green would conflict with _GREEN, and Blue would conflict with _BLUE, once the underscore was removed from those commands with $NOPREFIX.
To prevent these conflicts, the COLOR values have had NP_ prepended to the front of them, to distinguish them from the non-prefixed command names. All other color names remain the same, with only the three colors in conflict having to use NP_ (for No Prefix) in front of them.
Note that $NOPREFIX was deprecated in QB64-PE v4.0.0 and so also the NP_ color names are gone.


Examples

Example 1
Adding named color constants for SCREEN 0.
$COLOR:0

COLOR BrightWhite, Red
PRINT "Bright white on red."

Bright white on red.
Example 2
Adding named color constants for 32-bit modes.
SCREEN _NEWIMAGE(640, 400, 32)
$COLOR:32

COLOR CrayolaGold, DarkCyan
PRINT "CrayolaGold on DarkCyan."

CrayolaGold on DarkCyan.
Example 3
Adding named color constants for 32-bit modes (with $NOPREFIX in effect).
$NOPREFIX

SCREEN NEWIMAGE(640, 400, 32)
$COLOR:32

COLOR NP_Red, White 'notice the NP_ in front of Red?
'This is to distinguish the color from the command with $NOPREFIX.
PRINT "Red on White."

Red on White.


See also


Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link
Retrieved from "https://qb64phoenix.com/qb64wiki/index.php?title=$COLOR&oldid=9301"