bitmap.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:4k
- '"
- '" Copyright (c) 1994 The Regents of the University of California.
- '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
- '"
- '" See the file "license.terms" for information on usage and redistribution
- '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
- '"
- '" RCS: @(#) $Id: bitmap.n,v 1.2 1998/09/14 18:22:54 stanton Exp $
- '"
- .so man.macros
- .TH bitmap n 4.0 Tk "Tk Built-In Commands"
- .BS
- '" Note: do not modify the .SH NAME line immediately below!
- .SH NAME
- bitmap - Images that display two colors
- .SH SYNOPSIS
- fBimage create bitmap fR?fInamefR? ?fIoptionsfR?
- .BE
- .SH DESCRIPTION
- .PP
- 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 fIsourcefR
- and the fImaskfR.
- 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.
- .SH "CREATING BITMAPS"
- .PP
- Like all images, bitmaps are created using the fBimage createfR
- command.
- Bitmaps support the following fIoptionsfR:
- .TP
- fB-background fIcolorfR
- Specifies a background color for the image in any of the standard
- 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 fB-maskdatafR or fB-maskfilefR options.
- .TP
- fB-data fIstringfR
- Specifies the contents of the source bitmap as a string.
- The string must adhere to X11 bitmap format (e.g., as generated
- by the fBbitmapfR program).
- If both the fB-datafR and fB-filefR options are specified,
- the fB-datafR option takes precedence.
- .TP
- fB-file fInamefR
- fInamefR 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 fBbitmapfR program).
- .TP
- fB-foreground fIcolorfR
- Specifies a foreground color for the image in any of the standard
- ways accepted by Tk.
- .TP
- fB-maskdata fIstringfR
- Specifies the contents of the mask as a string.
- The string must adhere to X11 bitmap format (e.g., as generated
- by the fBbitmapfR program).
- If both the fB-maskdatafR and fB-maskfilefR options are specified,
- the fB-maskdatafR option takes precedence.
- .TP
- fB-maskfile fInamefR
- fInamefR 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 fBbitmapfR program).
- .SH "IMAGE COMMAND"
- .PP
- 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 various operations
- on the image.
- It has the following general form:
- .CS
- fIimageName option fR?fIarg arg ...fR?
- .CE
- fIOptionfR and the fIargfRs
- determine the exact behavior of the command. The following
- commands are possible for bitmap images:
- .TP
- fIimageName fBcgetfR fIoptionfR
- Returns the current value of the configuration option given
- by fIoptionfR.
- fIOptionfR may have any of the values accepted by the
- fBimage create bitmapfR command.
- .TP
- fIimageName fBconfigurefR ?fIoptionfR? ?fIvalue option value ...fR?
- Query or modify the configuration options for the image.
- If no fIoptionfR is specified, returns a list describing all of
- the available options for fIimageNamefR (see fBTk_ConfigureInfofR for
- information on the format of this list). If fIoptionfR is specified
- with no fIvaluefR, 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 fIoptionfR is specified). If
- one or more fIoption-valuefR 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.
- fIOptionfR may have any of the values accepted by the
- fBimage create bitmapfR command.
- .SH KEYWORDS
- bitmap, image