1
1
Fork 0
mirror of https://github.com/QB64-Phoenix-Edition/QB64pe.git synced 2024-07-01 15:00:38 +00:00
QB64-PE/internal/help/_GREEN.txt

33 lines
1.5 KiB
Plaintext
Raw Normal View History

2016-03-18 11:36:04 +00:00
{{DISPLAYTITLE:_GREEN}}
The [[_GREEN]] function returns the palette index or the green component intensity of a 32-bit image color.
{{PageSyntax}}
2017-10-10 14:55:21 +00:00
: {{Parameter|greenIntensity&}} = [[_GREEN]]({{Parameter|rgbaColorIndex&}}[, {{Parameter|imageHandle&}}])
{{PageDescription}}
* {{Parameter|rgbaColorIndex&}} is the ''RGBA'' color value or palette index of the color to retrieve the green component intensity from.
* The [[LONG]] intensity value returned ranges from 0 (no intensity, not present) to 255 (full intensity).
* If {{Parameter|imageHandle&}} specifies a 32-bit color image, {{Parameter|rgbaColorIndex&}} is interpreted as a 32-bit ''RGBA'' color value.
* If {{Parameter|imageHandle&}} specifies an image that uses a palette, {{Parameter|rgbaColorIndex&}} is interpreted as a palette index.
2017-10-10 14:55:21 +00:00
* If {{Parameter|imageHandle&}} is not specified, it is assumed to be the current write page (See [[_DEST]]).
* If {{Parameter|imageHandle&}} is an invalid handle, an [[ERROR Codes|invalid handle]] error will occur.
* If {{Parameter|rgbaColorIndex&}} is outside the range of valid indexes for a given image mode, an [[ERROR Codes|illegal function call]] error occurs.
2017-10-10 14:55:21 +00:00
* Uses index parameters passed by the [[_RGB]], [[_RGBA]], [[_RGB32]] or [[_RGBA32]] functions.
* An image handle is optional.
2017-10-10 14:55:21 +00:00
{{PageExamples}}
* See example in [[POINT]].
{{PageSeeAlso}}
2016-03-18 11:36:04 +00:00
* [[_RED]], [[_BLUE]]
* [[_RGB]], [[RGB32]]
* [[_LOADIMAGE]]
2019-04-15 01:15:33 +00:00
{{PageNavigation}}
<