1mNAME0m
       bitmap - Images that display two colors

1mSYNOPSIS0m
       1mimage create bitmap 22m?4mname24m? ?4moptions24m?


1mDESCRIPTION0m
       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  back-
       ground  color,  a  foreground color, and two bitmaps, called the 4msource0m
       and the 4mmask24m.  Each of the bitmaps specifies 0/1 values for a rectangu-
       lar array of pixels, and the two bitmaps must have the same dimensions.
       For pixels where the mask is zero, the image displays nothing,  produc-
       ing  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.


1mCREATING BITMAPS0m
       Like  all  images,  bitmaps are created using the 1mimage create 22mcommand.
       Bitmaps support the following 4moptions24m:

       1m-background 4m22mcolor0m
              Specifies a background color for the image in any of  the  stan-
              dard  ways  accepted  by  Tk.  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 1m-maskdata 22mor 1m-maskfile 22moptions.

       1m-data 4m22mstring0m
              Specifies the contents of the source bitmap as  a  string.   The
              string  must  adhere to X11 bitmap format (e.g., as generated by
              the 1mbitmap 22mprogram).  If both the 1m-data 22mand  1m-file  22moptions  are
              specified, the 1m-data 22moption takes precedence.

       1m-file 4m22mname0m
              4mname24m  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 1mbitmap 22mprogram).

       1m-foreground 4m22mcolor0m
              Specifies  a  foreground color for the image in any of the stan-
              dard ways accepted by Tk.

       1m-maskdata 4m22mstring0m
              Specifies the contents of the mask as a string.  The string must
              adhere  to  X11  bitmap format (e.g., as generated by the 1mbitmap0m
              program).  If both the 1m-maskdata 22mand 1m-maskfile 22moptions are spec-
              ified, the 1m-maskdata 22moption takes precedence.

       1m-maskfile 4m22mname0m
              4mname24m  gives  the  name of a file whose contents define the mask.
              The file must adhere to X11 bitmap format (e.g., as generated by
              the 1mbitmap 22mprogram).


1mIMAGE COMMAND0m
       When  a  bitmap  image  is created, Tk also creates a new command whose
       name is the same as the image.  This command may be used to invoke var-
       ious operations on the image.  It has the following general form:
              4mimageName24m 4moption24m ?4marg24m 4marg24m 4m...24m?
       4mOption24m  and  the 4marg24ms determine the exact behavior of the command.  The
       following commands are possible for bitmap images:

       4mimageName24m 1mcget 4m22moption0m
              Returns the current value of the configuration option  given  by
              4moption24m.  4mOption24m may have any of the values accepted by the 1mimage0m
              1mcreate bitmap 22mcommand.

       4mimageName24m 1mconfigure 22m?4moption24m? ?4mvalue24m 4moption24m 4mvalue24m 4m...24m?
              Query or modify the configuration options for the image.  If  no
              4moption24m is specified, returns a list describing all of the avail-
              able options for 4mimageName24m (see 1mTk_ConfigureInfo 22mfor information
              on  the  format  of  this list).  If 4moption24m is specified with no
              4mvalue24m, then the command returns a list describing the one  named
              option (this list will be identical to the corresponding sublist
              of the value returned if no 4moption24m is  specified).   If  one  or
              more 4moption-value24m pairs are specified, then the command modifies
              the given option(s) to have the given value(s);   in  this  case
              the command returns an empty string.  4mOption24m may have any of the
              values accepted by the 1mimage create bitmap 22mcommand.


1mKEYWORDS0m
