BACKGROUNDCOLOR: Difference between revisions

Revision as of 00:40, 14 November 2022

The _BACKGROUNDCOLOR function returns the current background color for an image handle or page.

col~& = _BACKGROUNDCOLOR [(imageHandle&)]

If imageHandle& is omitted, it is assumed to be the current write page or image designated by _DEST.
If imageHandle& is an invalid handle, an Invalid handle error occurs. Check handle values first. Zero designates the current screen.

Use it to get the current background color to restore it later in a program.
In legacy SCREEN modes and in _NEWIMAGE 256 colors mode the color attribute/palette index is returned.
In _NEWIMAGE 32-bit mode the _RGBA32 value (&H00000000 to &HFFFFFFFF) is returend, make sure to store it in an _UNSIGNED LONG variable (as seen in the syntax above with the ~& symbol), otherwise the blue component may be lost.

SCREEN 0
COLOR 1, 3 'set color 1 as foreground, color 3 as background
CLS
col~& = _BACKGROUNDCOLOR
PRINT col~&

@@ Line 6: / Line 6: @@
 :{{Parameter|col~&}} = [[_BACKGROUNDCOLOR]] [({{Parameter|imageHandle&}})]
+{{PageParameters}}
+* If {{Parameter|imageHandle&}} is omitted, it is assumed to be the current write page or image designated by [[_DEST]].
+* If {{Parameter|imageHandle&}} is an invalid handle, an [[ERROR Codes|Invalid handle]] error occurs. Check handle values first. Zero designates the current screen.
 {{PageDescription}}
-* If {{Parameter|imageHandle&}} is omitted, it is assumed to be the current write page or image designated by [[_DEST]].
-* If {{Parameter|imageHandle&}} is an invalid handle, an [[ERROR Codes|invalid handle]] error occurs. Check handle values first. Zero designates the current screen.
 * Use it to get the current background color to restore it later in a program.
 * In legacy [[SCREEN]] modes and in [[_NEWIMAGE]] 256 colors mode the color attribute/palette index is returned.