Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

 ◄Summary► ◄Example►                         ◄Up► ◄Contents► ◄Index► ◄Back►
─────Run-Time Library───────────────────────────────────────────────────────
 
     The _setbkcolor function sets the current background color to the
     color value <color>.
 
     In a color text mode (such as _TEXTC80), _setbkcolor accepts a
     color index. The values for the default colors are shown in a
     table in the description of the _settextcolor function.
     See: _settextcolor
 
     For example, _setbkcolor(2L) sets the background color to color
     index 2. The actual color displayed depends on the palette mapping
     for color index 2. The default is green in color text mode.
 
     In color graphics mode (such as _ERESCOLOR), _setbkcolor accepts
     a color value. The values for the simplest background colors are
     given by the manifest constants defined in GRAPH.H (for instance,
     _GREEN). These manifest constants are provided as a convenience in
     defining and manipulating the most common colors. The actual range
     of colors is, in general, much greater.
     See ◄Graphic Mode Colors►
 
     In general, whenever a <color> argument is a long, it refers to a
     color value, and when it is a short, it refers to a color index.
     The two exceptions are _setbkcolor and _getbkcolor.
 
     Using an argument of 0 for the _remappalette function will do what
     _setbkcolor does. Unlike _remappalette, however, _setbkcolor does
     not require an EGA or VGA environment.
 
     In text mode, the _setbkcolor function does not affect anything
     already appearing on the display (only the subsequent output). In
     graphics mode, it immediately changes all background pixels.
 
     Return Value
 
     In text modes, _setbkcolor returns the color index of the old
     background color. In graphics modes, _setbkcolor returns the old
     color value of color index 0. There is no error return. Use the
     _grstatus function to check the status after a call to
     _setbkcolor.
                                    -♦-