Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

GPR_$INQ_FILL_BACKGROUND_VALUE    GPR Calls     GPR_$INQ_FILL_BACKGROUND_VALUE


NAME
     gpr_$inq_fill_background_value - returns the tile fill background color.

FORMAT
     gpr_$inq_fill_background_value (color, status)

DESCRIPTION
     This routine returns the color of the background used for tile fills.

   Output Parameters
     color
          The color that the system is using for tile fills, 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 table.

             ⊕  0 - 16,777,215 A color value for a true-color program.

             ⊕  -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 specifies that the fill background
                color is equal to the bitmap background color.  For borrowed
                displays and memory bitmaps, the fill background is always
                zero.  For Display Manager frames, this is the pixel value in
                use for the window background.

     status
        Completion status, in status_$t format.

SEE ALSO
     gpr_$set_fill_background_value.

Typewritten Software • bear@typewritten.org • Edmonds, WA 98026