DEFAULTCOLOR: Difference between revisions

Revision as of 00:47, 19 November 2022

The _DEFAULTCOLOR function returns the current default (text/drawing) color for an image handle or page.

col~& = _DEFAULTCOLOR [(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 default (foreground) 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 ~& suffix), otherwise the blue component may be lost.

Example: Storing the default color for later use. The default color is the color set as foreground.

SCREEN 0
COLOR 4, 7 'set color 4 as foreground, color 7 as background
CLS
col~& = _DEFAULTCOLOR
PRINT col~&

@@ Line 10: / Line 10: @@
 * 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}}