'\" '\" Generated from file 'format-header\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 1995-2009 Jan Nijtmans '\" .TH "img-bmp" 3tk 1\&.4 img-bmp "Img" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME img-bmp \- Img, Windows Bitmap Format (bmp) .SH SYNOPSIS package require \fBTk \fR .sp package require \fBimg::bmp ?1\&.4?\fR .sp \fBimage\fR \fBcreate photo\fR ?\fIname\fR? ?\fIoptions\fR? .sp .BE .SH DESCRIPTION The package \fBimg::bmp\fR is a sub-package of \fBImg\fR\&. It can be loaded as a part of the complete Img support, via \fBpackage require Img\fR, or on its own, via \fBpackage require img::bmp\fR\&. .PP Like all packages of \fBImg\fR it does \fInot\fR provide new commands, but extends the existing \fBTk\fR command \fBimage\fR so that it supports files containing raster images in the Windows Bitmap Format (bmp)\&. More specifically \fBimg::bmp\fR extends \fBTk\fR's \fBphoto\fR image type\&. .PP The name of the new format handler is \fBbmp\fR\&. This handler provides new additional configuration options\&. See section \fBBMP OPTIONS\fR for more detailed explanations\&. .PP All of the above means that in a call like .TP \fBimage\fR \fBcreate photo\fR ?\fIname\fR? ?\fIoptions\fR? .PP .IP [1] Image data in bmp format (options \fB-data\fR and \fB-file\fR) is detected automatically\&. .IP [2] The format name \fBbmp\fR is recognized by the option \fB-format\fR\&. In addition the value for the option is treated as list and may contain any of the special options listed in section \fBBMP OPTIONS\fR\&. .PP .SH "BMP OPTIONS" The handler provides an option to influence the writing of a BMP image\&. .TP \fB-resolution\fR \fIres\fR The display resulation and/or aspect ratio property of the outputted bmp file may be set using this option\&. The default values are an x and y resolution of 74 dpi\&. \fIres\fR is a list of 2 or 3 elements and may have one of the following formats\&. The values \fIxres\fR, \fIyres\fR and \fIunit\fR are specified after the formats\&. .RS .TP \fIres\fR = \fIxres\fR \fIunit\fR Set the same resolution for x and y\&. Example: Write image with a resolution of 300dpi: .CS img write out\&.bmp -format {bmp -resolution {300 i}} .CE .TP \fIres\fR = \fIxres\fR \fIyres\fR Set the aspect ratio only\&. The x resolution remains to the default value 74dpi, as the bmp format does not allow to specify the aspect ratio only\&. The y resolution is set to 74*\fIyres\fR/\fIxres\fR\&. Example: Write image with an aspect ratio of 1/3: .CS img write out\&.bmp -format {bmp -resolution {1 3}} .CE .TP \fIres\fR = \fIxres\fR \fIyres\fR \fIunit\fR Set an independent resolution for x and y direction\&. Example: Write image with a resolution of x=300dpi and y=150dpi: .CS img write out\&.bmp -format {bmp -resolution {300 100 i}} .CE .RE .IP The used parameters are: .RS .TP float \fIxres\fR (input) The output resolution in x direction as a float number\&. .TP float \fIyres\fR (input) The output resolution in x direction as a float number\&. .TP string \fIunit\fR (input) Unit of the given resolution numbers similar to Tk_GetPixel\&. Possible units are: .RS .TP c pixel per centimeter\&. .TP m pixel per meter\&. .TP i pixel per inch\&. .TP p pixel per inch/72 (Printer points)\&. .RE .RE .PP .PP .SH "SEE ALSO" img-bmp, img-dted, img-gif, img-ico, img-intro, img-jpeg, img-pcx, img-pixmap, img-png, img-ppm, img-ps, img-raw, img-sgi, img-sun, img-tga, img-tiff, img-window, img-xbm, img-xpm .SH KEYWORDS bmp, image handling, tk .SH COPYRIGHT .nf Copyright (c) 1995-2009 Jan Nijtmans .fi