gpr_set_text_background_value() — Apollo Domain/OS SR10.3.5

GPR_$SET_TEXT_BACKGROUND_VALUE    GPR Calls     GPR_$SET_TEXT_BACKGROUND_VALUE


NAME
     gpr_$set_text_background_value - specifies the color to use for text
     background.

FORMAT
     gpr_$set_text_background_value (color, status)

DESCRIPTION
     This routine specifies the color to use for text background.  The default
     text background value is -2.

     For monochromatic displays, only the low-order bit of the text background
     value is considered because monochromatic displays have only one plane.

     For color displays in 4-bit pixel mode, only the four lowest-order bits
     of the text background value are considered because these displays have
     four planes.

   Input Parameters
     color
          The color to be used for the text background, in gpr_$pixel_value_t
          format.  This is a 4-byte integer.  Valid values are:

             ⊕  0 - 1 For monochromatic displays.

             ⊕  0 - 15 An index into a 4-plane color table.

             ⊕  0 - 255 An index into an 8-plane color table.

             ⊕  0 - 4096 An index into a 12-plane true-color map.

             ⊕  0 - 16,777,215 A color value for a 24-plane true-color pro-
                gram.

             ⊕  -1 For all displays.  This specifies that the background is
                transparent; that is, the old values of the pixels are not
                changed.

             ⊕  -2 For all displays.  This sets the text background color
                equal to the bitmap background color.  For borrowed displays
                and memory bitmaps, the bitmap background is always zero.  For
                Display Manager frames, this is the pixel value in use for the
                window background.

   Output Parameters
     status
          Completion status, in status_$t format.

SEE ALSO
     gpr_$inq_values.
Museum
