BitmapImage - Images that display two colors

SYNOPSIS

imageName = tkinter.BitmapImage([**options])

DESCRIPTION

A bitmap is an image whose pixels can display either of two colors or be transparent. A bitmap image is defined by four things: a background color, a foreground color, and two bitmaps, called the source and the mask. Each of the bitmaps specifies 0/1 values for a rectangular array of pixels, and the two bitmaps must have the same dimensions. For pixels where the mask is zero, the image displays nothing, producing a transparent effect. For other pixels, the image displays the foreground color if the source data is one and the background color if the source data is zero.

SPECIFIC OPTIONS

Bitmaps support the following options:

background=color

Specifies a background color for the image in any of the standard ways accepted by Tkinter. If this option is set to an empty string then the background pixels will be transparent. This effect is achieved by using the source bitmap as the mask bitmap, ignoring any maskdata or maskfile options.

data="string"

Specifies the contents of the source bitmap as a string. The string must adhere to X11 bitmap format (e.g., as generated by the bitmap program). If both the data and file options are specified, the data option takes precedence.

file=name

name gives the name of a file whose contents define the source bitmap. The file must adhere to X11 bitmap format (e.g., as generated by the bitmap program).

foreground=color

Specifies a foreground color for the image in any of the standard ways accepted by Tkinter.

METHODS

The following methods are possible for bitmap images:

imageName.configure(**options)

If one or more option-value pairs are specified, then the command modifies the given option(s) to have the given value(s); in this case the method returns an empty string. Option may have any of the values accepted by the BitmapImage class.