QB64-PE/internal/help/_RGB32.txt

{{DISPLAYTITLE:_RGB32}}
The [[_RGB32]] function returns the 32-bit ''RGBA'' color value with specified red, green and blue component intensities and optional alpha.


{{PageSyntax}}
''Original syntax'':
:{{Parameter|color32value~&}} = [[_RGB32]]({{Parameter|red&}}, {{Parameter|green&}}, {{Parameter|blue&}})

''Alternative Syntax 2'':
:{{Parameter|color32value~&}} = [[_RGB32]]({{Parameter|red&}}, {{Parameter|green&}}, {{Parameter|blue&}}, {{Parameter|alpha&}})

''Alternative Syntax 3'':
:{{Parameter|color32value~&}} = [[_RGB32]]({{Parameter|intensity&}}, {{Parameter|alpha&}})

''Alternative Syntax 4'':
:{{Parameter|color32value~&}} = [[_RGB32]]({{Parameter|intensity&}})


{{Parameters}}
* {{Parameter|red&}} specifies the red [[LONG]] component intensity from 0 to 255.
* {{Parameter|green&}} specifies the green [[LONG]] component intensity from 0 to 255.
* {{Parameter|blue&}} specifies the blue [[LONG]] component intensity from 0 to 255.
* {{Parameter|alpha&}} specifies the alpha [[LONG]] component from 0 to 255.
* {{Parameter|intensity&}} specifies the red, green and blue [[LONG]] components intensity from 0 to 255 simultaneously, to generate a shade of gray.

{{PageDescription}}
* The value returned is always a 32-bit [[_UNSIGNED]] [[LONG]] color value, as is the [[POINT]] value. 
* '''Return variable types must be [[_UNSIGNED]] [[LONG]] or [[LONG]], otherwise resulting color may lose the [[_BLUE]] value.'''
* Parameter values outside of the 0 to 255 range are clipped.
* Returns [[LONG]] 32 bit hexadecimal values from '''&H00{{text|00|red}}{{text|00|green}}{{text|00|blue}}''' to '''&HFF{{text|FF|red}}{{text|FF|green}}{{text|FF|blue}}'''.
* When [[LONG]] values are [[PUT]] to file, the ARGB values become BGRA. Use [[LEFT$]]([[MKL$]]({{Parameter|color32value~&}}), 3) to place 3 colors.
* '''NOTE: Default 32-bit backgrounds are clear black or [[_RGB32]](0, 0). Use [[CLS]] to make the black opaque.'''


==Availability==
* Alternative syntaxes available with '''version 1.3 and up'''.


{{PageExamples}}
''Example 1:'' Converting the color port RGB intensity palette values 0 to 63 to 32 bit hexadecimal values. 
{{CodeStart}}
{{Cl|SCREEN}} 12
{{Cl|DIM}} hex32$(15)
{{Cl|FOR...NEXT|FOR}} attribute = 1 {{Cl|TO}} 15
  {{Cl|OUT}} {{Cl|&H}}3C7, attribute      'set color attribute to read
  red = {{Cl|INP}}({{Cl|&H}}3C9) * 4      'multiply by 4 to convert intensity to 0 to 255 RGB values
  grn = {{Cl|INP}}({{Cl|&H}}3C9) * 4
  blu = {{Cl|INP}}({{Cl|&H}}3C9) * 4
  hex32$(attribute) = "{{Cl|&H}}" + {{Cl|HEX$}}({{Cl|_RGB32}}(red, grn, blu))   'always returns the 32 bit value
  {{Cl|COLOR}} attribute
  {{Cl|PRINT}} "{{Cl|COLOR}}" + {{Cl|STR$}}({{Cl|_RGB}}(red, grn, blu)) + " = " + hex32$(attribute)  'closest attribute
{{Cl|NEXT}} '' ''
{{CodeEnd}}
{{OutputStart}}{{text|COLOR 1 <nowiki>=</nowiki> &HFF0000A8|#0000A8}}
{{text|COLOR 2 <nowiki>=</nowiki> &HFF00A800|#00A800}}
{{text|COLOR 3 <nowiki>=</nowiki> &HFF00A8A8|#00A8A8}}
{{text|COLOR 4 <nowiki>=</nowiki> &HFFA80000|#A80000}}
{{text|COLOR 5 <nowiki>=</nowiki> &HFFA800A8|#A800A8}}
{{text|COLOR 6 <nowiki>=</nowiki> &HFFA85400|#A85400}}
{{text|COLOR 7 <nowiki>=</nowiki> &HFFA8A8A8|#A8A8A8}}
{{text|COLOR 8 <nowiki>=</nowiki> &HFF545454|#545454}}
{{text|COLOR 9 <nowiki>=</nowiki> &HFF5454FC|#5454FC}}
{{text|COLOR 10 <nowiki>=</nowiki> &HFF54FC54|#54FC54}}
{{text|COLOR 11 <nowiki>=</nowiki> &HFF54FCFC|#54FCFC}}
{{text|COLOR 12 <nowiki>=</nowiki> &HFFFC5454|#FC5454}}
{{text|COLOR 13 <nowiki>=</nowiki> &HFFFC54FC|#FC54FC}}
{{text|COLOR 14 <nowiki>=</nowiki> &HFFFCFC54|#FCFC54}}
{{text|COLOR 15 <nowiki>=</nowiki> &HFFFCFCFC|#FCFCFC}}
{{OutputEnd}}
:''Note:'' This procedure also shows how the returns from [[_RGB]] and [[_RGB32]] differ in a non-32 bit screen mode.


''Example 2:'' Working with 32 bit colors.
{{CodeStart}} '' ''
{{Cl|SCREEN}} {{Cl|_NEWIMAGE}}(640, 480, 32)

{{Cl|CLS}} , {{Cl|_RGB32}}(0, 0, 128) 'deep blue background

{{Cl|LINE}} (100, 100)-(540, 380), {{Cl|_RGB}}(255, 0, 0), BF ' a red box
{{Cl|LINE}} (200, 200)-(440, 280), {{Cl|_RGB}}(0, 255, 0), BF ' a green box


{{Cl|SLEEP}} 'Just so we can see our pretty background before we print anything on it.


{{Cl|COLOR}} {{Cl|_RGB32}}(255, 255, 255), 0 'White on NO BACKGROUND

{{Cl|FOR...NEXT|FOR}} i = 1 {{Cl|TO}} 10
    {{Cl|PRINT}} "This is just a whole bunch of happy nothing!  Happy World!!"
{{Cl|NEXT}}
{{Cl|PRINT}}: {{Cl|PRINT}}: {{Cl|PRINT}}:

{{Cl|COLOR}} 0, {{Cl|_RGB32}}(0, 0, 0) 'And here, we're going with NO {{Cl|COLOR}} text, with a BLACK background.
'Notice how this doesn't change the color on the screen at all, where the text is, but does toss a black background to it.

{{Cl|LOCATE}} , 15: {{Cl|PRINT}} "NOTICE HOW OUR 0 {{Cl|COLOR}} WORKS?"
{{Cl|PRINT}}
{{Cl|LOCATE}} , 15: {{Cl|PRINT}} "NEAT, HUH?"
{{Cl|SLEEP}}
SYSTEM '' ''
{{CodeEnd}}{{small|Code by Steve McNeill}}


''Example 3:'' Comparing the output of the new _RGB32 syntaxes (starting with version 1.3) and their equivalents in previous versions. 
{{CodeStart}}
{{Cl|SCREEN}} {{Cl|_NEWIMAGE}}(400, 400, 32)

{{Cl|COLOR}} {{Cl|_RGB32}}(255, 255, 255)
{{Cl|PRINT}} "White"
{{Cl|COLOR}} {{Cl|_RGB32}}(255)
{{Cl|PRINT}} "White, too, but with less typing"
{{Cl|PRINT}}

{{Cl|COLOR}} {{Cl|_RGB32}}(80, 80, 80)
{{Cl|PRINT}} "Dark gray"
{{Cl|COLOR}} {{Cl|_RGB32}}(80)
{{Cl|PRINT}} "Same gray, but with less typing"
{{Cl|PRINT}}

{{Cl|COLOR}} {{Cl|_RGBA32}}(255, 255, 255, 120)
{{Cl|PRINT}} "White with alpha of 120 (out of 255)"
{{Cl|COLOR}} {{Cl|_RGB32}}(255, 120)
{{Cl|PRINT}} "White with alpha of 120 - but with less typing"
{{Cl|PRINT}}

{{Cl|COLOR}} {{Cl|_RGBA32}}(255, 0, 255, 110)
{{Cl|PRINT}} "Magenta, 110 alpha"
{{Cl|COLOR}} {{Cl|_RGB32}}(255, 0, 255, 110)
{{Cl|PRINT}} "Magenta too, 110 alpha - but with less typing"
{{CodeEnd}}


{{PageSeeAlso}}
* [[_RGBA32]], [[_RGB]], [[_RGBA]]
* [[_RED32]], [[_GREEN32]], [[_BLUE32]]
* [[_PALETTECOLOR]]
* [[HEX$ 32 Bit Values]]
* [[SAVEIMAGE]]
* [http://www.w3schools.com/html/html_colornames.asp Hexadecimal Color Values]


{{PageNavigation}}
<