.TH "Bitmap" 3 "Mon Jan 12 2015" "Version dvi2bitmap1.0" "dvi2bitmap" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Bitmap \- 
.PP
Represents an abstract bitmap\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Bitmap\&.h>\fP
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBBitmapColour_s\fP"
.br
.ti -1c
.RI "class \fBconst_iterator\fP"
.br
.RI "\fIIterator class\&. \fP"
.in -1c
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBMargin\fP { \fBLeft\fP =0, \fBRight\fP =1, \fBTop\fP =2, \fBBottom\fP =3, \fBAll\fP }"
.br
.ti -1c
.RI "typedef struct 
.br
\fBBitmap::BitmapColour_s\fP \fBBitmapColour\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBBitmap\fP (const int width, const int height, const int bpp=1, bool expandable=true, const int maxwidth=-1, const int maxheight=-1)  throw (BitmapError)"
.br
.RI "\fICreate a new bitmap with the given parameters\&. \fP"
.ti -1c
.RI "\fB~Bitmap\fP ()"
.br
.ti -1c
.RI "void \fBpaint\fP (const int x, const int y, const int w, const int h, const \fBByte\fP *b)  throw (BitmapError)"
.br
.RI "\fIPaint a bitmap onto the master bitmap\&. \fP"
.ti -1c
.RI "void \fBrule\fP (const int x, const int y, const int w, const int h)  throw (BitmapError)"
.br
.RI "\fIDraws on the master bitmap a block (a `rule' in TeX terms) of height h and width w pixels\&. \fP"
.ti -1c
.RI "void \fBstrut\fP (const int x, const int y, const int l, const int r, const int t, const int b)  throw (BitmapError)"
.br
.RI "\fIDraws a `strut' on the master bitmap\&. \fP"
.ti -1c
.RI "void \fBwrite\fP (const string filename, const string format)  throw (BitmapError)"
.br
.RI "\fIWrites the bitmap out to the specified file\&. \fP"
.ti -1c
.RI "void \fBfreeze\fP ()"
.br
.RI "\fIFreeze the bitmap and bounding box\&. \fP"
.ti -1c
.RI "void \fBcrop\fP ()"
.br
.RI "\fICrops the bitmap\&. \fP"
.ti -1c
.RI "void \fBcrop\fP (\fBMargin\fP spec, int pixels, bool absolute=false)  throw (BitmapError)"
.br
.RI "\fISpecifies a crop\&. \fP"
.ti -1c
.RI "void \fBblur\fP ()"
.br
.RI "\fIMakes a very simple-minded attempt to antialias the bitmap by blurring it\&. \fP"
.ti -1c
.RI "void \fBclear\fP ()"
.br
.RI "\fIResets the bitmap to its initial state\&. \fP"
.ti -1c
.RI "void \fBsetTransparent\fP (const bool sw)"
.br
.RI "\fISets the current bitmap to be transparent, if possible\&. \fP"
.ti -1c
.RI "void \fBsetRGB\fP (const bool fg, const \fBBitmapColour\fP *)"
.br
.RI "\fISets the foreground or background colour\&. \fP"
.ti -1c
.RI "void \fBscaleDown\fP (const int factor)  throw (BitmapError)"
.br
.RI "\fIScales down the bitmap by a numerical factor\&. \fP"
.ti -1c
.RI "bool \fBempty\fP () const "
.br
.RI "\fIIs the bitmap empty? If nothing has (yet) been written to the bitmap, or if everything that was written was out of bounds, then the bitmap is empty\&. \fP"
.ti -1c
.RI "bool \fBoverlaps\fP () const "
.br
.RI "\fIDoes the bitmap overlap its canvas? This can only be true before a (implicit or explicit) call to \fBfreeze\fP, since that normalizes the bounding box variables\&. \fP"
.ti -1c
.RI "int * \fBboundingBox\fP ()"
.br
.RI "\fIObtain a bounding box for the current bitmap\&. \fP"
.ti -1c
.RI "int \fBgetWidth\fP () const "
.br
.RI "\fIReturns the total width of the bitmap\&. \fP"
.ti -1c
.RI "int \fBgetHeight\fP () const "
.br
.RI "\fIReturns the total height of the bitmap\&. \fP"
.ti -1c
.RI "void \fBmark\fP (\fBDviFilePosition\fP *)"
.br
.RI "\fIMarks a particular spot in the bitmap\&. \fP"
.ti -1c
.RI "\fBDviFilePosition\fP * \fBgetMark\fP ()"
.br
.RI "\fIObtains the mark for this bitmap\&. \fP"
.ti -1c
.RI "\fBconst_iterator\fP \fBbegin\fP ()"
.br
.RI "\fIReturns the beginning of a sequence of bitmap rows\&. \fP"
.ti -1c
.RI "\fBconst_iterator\fP \fBend\fP () const "
.br
.RI "\fIReturns the end of a sequence of bitmap rows\&. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBcropDefault\fP (\fBMargin\fP spec, int pixels, bool absolute=false)  throw (BitmapError)"
.br
.RI "\fISpecifies a default crop\&. \fP"
.ti -1c
.RI "static void \fBsetDefaultRGB\fP (const bool fg, const \fBBitmapColour\fP *)"
.br
.RI "\fISets the default foreground or background colours\&. \fP"
.ti -1c
.RI "static \fBverbosities\fP \fBverbosity\fP (const \fBverbosities\fP level)"
.br
.RI "\fISets the verbosity of the current class\&. \fP"
.ti -1c
.RI "static void \fBlogBitmapInfo\fP (const char *prefix)"
.br
.RI "\fISets whether bitmap information is logged\&. \fP"
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBconst_iterator\fP \fBrunningIterator_\fP"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static \fBconst_iterator\fP \fBendIterator_\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Represents an abstract bitmap\&. 

The bitmaps written to file are subclasses of the class \fBBitmapImage\fP\&. 
.SH "Member Typedef Documentation"
.PP 
.SS "typedef struct \fBBitmap::BitmapColour_s\fP  \fBBitmap::BitmapColour\fP"

.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBBitmap::Margin\fP"

.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fILeft \fP\fP
.TP
\fB\fIRight \fP\fP
.TP
\fB\fITop \fP\fP
.TP
\fB\fIBottom \fP\fP
.TP
\fB\fIAll \fP\fP
.SH "Constructor & Destructor Documentation"
.PP 
.SS "Bitmap::Bitmap (const intw, const inth, const intbpp = \fC1\fP, boolexpandable = \fCtrue\fP, const intmaxwidth = \fC-1\fP, const intmaxheight = \fC-1\fP)\fBBitmapError\fP"

.PP
Create a new bitmap with the given parameters\&. Coordinates on the bitmap run from 0 to W-1, and 0 to H-1, with point (0,0) in the top-left corner, the \fIx\fP-axis increasing to the right, and the \fIy\fP-axis increasing downwards\&.
.PP
\fBParameters:\fP
.RS 4
\fIw\fP the width of the bitmap, in pixels
.br
\fIh\fP the height of the bitmap, in pixels
.br
\fIbpp\fP the number of bits-per-pixel (default is 1)
.br
\fIexpandable\fP if true (the default), the bitmap is expandable; if false, the bitmap is fixed at the specified size
.br
\fImaxwidth\fP if \fCexpandable\fP is true, and \fCmaxwidth\fP is greater than or equal to \fCw\fP, this is the maximum horizontal size the bitmap will expand to; if it is less than \fCw\fP (which includes negative, the default), the maximum width is set to a default multiplier of the width \fCw\fP
.br
\fImaxheight\fP if \fCexpandable\fP is true, and \fCmaxheight\fP is greater than or equal to \fCh\fP, this is the maximum vertical size the bitmap will expand to; if \fCmaxheight\fP is less than \fCh\fP (which includes negative, the default), the maximum vertical size will be such that \fCmaxheight/h==maxwidth/w\fP
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBBitmapError\fP\fP if the arguments are inconsistent 
.RE
.PP

.PP
References normal, and Util::verbosity_\&.
.SS "Bitmap::~Bitmap ()"

.SH "Member Function Documentation"
.PP 
.SS "\fBBitmap::const_iterator\fP Bitmap::begin ()"

.PP
Returns the beginning of a sequence of bitmap rows\&. Freezes the bitmap as a side-effect\&. 
.PP
References freeze(), and runningIterator_\&.
.SS "void Bitmap::blur ()"

.PP
Makes a very simple-minded attempt to antialias the bitmap by blurring it\&. Opening the DVI file with a magnification setting, and then calling \fBscaleDown\fP will generally produce a much better effect\&.
.PP
Freezes the bitmap as a side-effect\&. 
.PP
References empty(), and freeze()\&.
.PP
Referenced by main()\&.
.SS "int * Bitmap::boundingBox ()"

.PP
Obtain a bounding box for the current bitmap\&. This returns a four-element array consisting of, in order, 
.PD 0

.IP "\(bu" 2
[0] = the coordinate of the leftmost blackened pixel, 
.IP "\(bu" 2
[1] = the coordinate of the topmost blackened pixel, 
.IP "\(bu" 2
[2] = one more than the coordinate of the rightmost blackened pixel, and 
.IP "\(bu" 2
[3] = one more than the coordinate of the bottommost blackened pixel\&. 
.PP
Thus \fC[2]-[0]\fP is the number of pixels which the blackened area occupies in the horizontal direction\&. Note that `blackened pixels' here includes those notionally blackened by the \fC\fBstrut\fP()\fP method\&. If the bitmap has been cropped, this bounding box reflects the crop margins\&.
.PP
The returned array occupies static storage, and is always current as of the last time this method was called\&.
.PP
The methods \fC\fBgetWidth\fP()\fP and \fC\fBgetHeight\fP()\fP return the size of the bitmap irrespective of the bounding box and any cropping\&.
.PP
It is possible for the bounding-box to be bigger than the bitmap, if rules or bitmaps have been painted on the bitmap in such a way that they overlap the boundaries of the bitmap, \fIand\fP if it is called before an explicit or implicit call to \fC\fBfreeze\fP()\fP\&. This can also be detected by a call to \fC\fBoverlaps\fP()\fP before any call to \fC\fBfreeze()\fP\fP\&. It is never bigger than the bitmap after the bitmap is frozen\&.
.PP
Note that the order of the four dimensions is \fInot\fP that of the Postscript BoundingBox, which is (llx, lly, urx, ury) rather than here, effectively, (ulx, uly, lrx, lry)\&. This is because the position of the upper-left corner (ulx, uly) is the natural TeX reference point\&.
.PP
\fBReturns:\fP
.RS 4
the position of the bitmap bounding-box, in the order (ulx, uly, lrx, lry) 
.RE
.PP

.PP
Referenced by main()\&.
.SS "void Bitmap::clear ()"

.PP
Resets the bitmap to its initial state\&. This clears the bitmap by setting all the pixels to white, unfreezing it, and resetting the bounding box and crops to their initial states\&. It does not deallocate any memory, however, so if the bitmap has expanded in the past, the reset bitmap is the same size\&.
.PP
It does not reset the transparency flag or adjust the colour setting, or reset the pixel depth\&. This latter behaviour \fImay\fP change in future\&. 
.PP
References Bottom, Left, normal, Right, and Top\&.
.PP
Referenced by main()\&.
.SS "void Bitmap::crop ()"

.PP
Crops the bitmap\&. This applies the cropping specified in methods \fBcrop(Margin,int,bool)\fP and \fBcropDefault\fP\&.
.PP
Freezes the bitmap as a side-effect\&. 
.PP
References Bottom, freeze(), Left, normal, Right, and Top\&.
.PP
Referenced by main()\&.
.SS "void Bitmap::crop (\fBMargin\fPspec, intpixels, boolabsolute = \fCfalse\fP)\fBBitmapError\fP"

.PP
Specifies a crop\&. If the \fCabsolute\fP flag is true, then set up a crop for the margin specified in \fCspec\fP: for the left and right margins, the crop in \fCpixels\fP is a distance from the \fIleft\fP margin; for the top and bottom crops, it is from the \fItop\fP margin\&. If the \fCabsolute\fP flag is false, then the distance in the \fCpixels\fP parameter is the distance `outward' of the eventual bounding-box, or at the edge of the bitmap, whichever comes first\&.
.PP
Since the implication of this is that a call 
.PP
.nf

  \&.crop(All, x, true);
.fi
.PP
 would set the crop box to be zero size, this combination is forbidden\&.
.PP
\fBParameters:\fP
.RS 4
\fIspec\fP the margin the crop is being specified for 
.br
\fIpixels\fP the size of the margin, or the position when \fCabsolute\fP is true 
.br
\fIabsolute\fP if true, then the margin specified is an absolute position relative to the left or top margin as appropriate; if false, then it is relative to the eventual size and position of the bounding box 
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBBitmapError\fP\fP if \fCspec=All\fP when \fCabsolute\fP is true 
.RE
.PP

.SS "void Bitmap::cropDefault (\fBMargin\fPspec, intpixels, boolabsolute = \fCfalse\fP)\fBBitmapError\fP\fC [static]\fP"

.PP
Specifies a default crop\&. This is exactly the same as \fBcrop(Margin,int,bool)\fP, except that it specifies this for all the bitmaps subsequently created by this class\&.
.PP
\fBParameters:\fP
.RS 4
\fIspec\fP the margin the crop is being specified for 
.br
\fIpixels\fP the size of the margin, or the position when \fCabsolute\fP is true 
.br
\fIabsolute\fP if true, then the margin specified is an absolute position relative to the left or top margin as appropriate; if false, then it is relative to the eventual size and position of the bounding box 
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBBitmapError\fP\fP if \fCspec=All\fP when \fCabsolute\fP is true 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBcrop(Margin,int,bool)\fP 
.RE
.PP

.PP
Referenced by main()\&.
.SS "bool Bitmap::empty () const\fC [inline]\fP"

.PP
Is the bitmap empty? If nothing has (yet) been written to the bitmap, or if everything that was written was out of bounds, then the bitmap is empty\&. 
.PP
\fBReturns:\fP
.RS 4
true if the bitmap is empty 
.RE
.PP

.PP
Referenced by blur(), and main()\&.
.SS "\fBBitmap::const_iterator\fP Bitmap::end () const"

.PP
Returns the end of a sequence of bitmap rows\&. 
.PP
References endIterator_\&.
.SS "void Bitmap::freeze ()"

.PP
Freeze the bitmap and bounding box\&. This prevents any further changes to the bitmap by the methods \fC\fBpaint()\fP\fP, \fC\fBrule()\fP\fP and \fC\fBstrut()\fP\fP\&. Other methods in this class such as \fC\fBcrop()\fP\fP and \fC\fBblur()\fP\fP call this method implicitly\&.
.PP
If method \fC\fBboundingBox()\fP\fP is called before this method, it is possible for it to report a size larger than the bitmap, if rules or bitmaps have been placed so that they overlap the bitmap's boundaries\&. The call to \fCfreeze\fP normalises the bounding box so that this is no longer the case\&. 
.PP
Referenced by begin(), blur(), and crop()\&.
.SS "int Bitmap::getHeight () const\fC [inline]\fP"

.PP
Returns the total height of the bitmap\&. This may not the the initial size of the bitmap, if it has expanded since then\&. 
.PP
\fBReturns:\fP
.RS 4
height of bitmap 
.RE
.PP

.SS "\fBDviFilePosition\fP * Bitmap::getMark ()"

.PP
Obtains the mark for this bitmap\&. 
.PP
\fBReturns:\fP
.RS 4
a pointer to the mark information, or 0 if no mark has been registered\&. This points to static storage, which should not be deleted, and which may be overwritten\&. 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBmark\fP 
.RE
.PP

.PP
References DviFilePosition::copy(), DviFilePosition::shift(), and DviFile::unit_pixels\&.
.SS "int Bitmap::getWidth () const\fC [inline]\fP"

.PP
Returns the total width of the bitmap\&. This may not the the initial size of the bitmap, if it has expanded since then\&. 
.PP
\fBReturns:\fP
.RS 4
width of bitmap 
.RE
.PP

.SS "static void Bitmap::logBitmapInfo (const char *prefix)\fC [inline]\fP, \fC [static]\fP"

.PP
Sets whether bitmap information is logged\&. If logging is enabled, then the details of the bitmaps are sent to the \fCstdout\fP prefixed by the given string\&.
.PP
\fBParameters:\fP
.RS 4
\fIprefix\fP if non-null, then bitmap activity is logged on stdout with this prefix; if null, such logging is turned off 
.RE
.PP

.PP
Referenced by main()\&.
.SS "void Bitmap::mark (\fBDviFilePosition\fP *p)"

.PP
Marks a particular spot in the bitmap\&. This spot can be retrieved later using \fBgetMark\fP\&. The top-left pixel in the bitmap has mark coordinates (0,0)\&. The input coordinates are not restricted to be on the bitmap\&.
.PP
\fBParameters:\fP
.RS 4
\fIp\fP a \fBDviFilePosition\fP representing the marked position 
.RE
.PP

.PP
References DviFilePosition::getX(), DviFilePosition::getY(), normal, and DviFile::unit_pixels\&.
.PP
Referenced by main()\&.
.SS "bool Bitmap::overlaps () const"

.PP
Does the bitmap overlap its canvas? This can only be true before a (implicit or explicit) call to \fBfreeze\fP, since that normalizes the bounding box variables\&. 
.PP
\fBReturns:\fP
.RS 4
true if the bitmap overlaps its canvas; always false after any call to \fC\fBfreeze()\fP\fP 
.RE
.PP

.PP
References normal\&.
.PP
Referenced by main()\&.
.SS "void Bitmap::paint (const intx, const inty, const intw, const inth, const \fBByte\fP *b)\fBBitmapError\fP"

.PP
Paint a bitmap onto the master bitmap\&. The bitmap to be added is given in a one-dimensional array \fCb\fP, which is \fCw\fP pixels wide and \fCh\fP high\&. Like the master bitmap, the \fIx\fP axis runs horizontally and the \fIy\fP axis vertically downwards\&.
.PP
The pixel at position \fI(x,y)\fP on the new bitmap is at position \fCb[y*w+x]\fP in the input bitmap array\&. This new bitmap is painted onto the master bitmap with its top left corner pixel (namely position \fI(0,0)\fP) occupying pixel \fI(x,y)\fP on the master bitmap, and pixel \fI(a,b)\fP occupying pixel \fI(x+a,y+b)\fP unless this would be off the master bitmap\&.
.PP
Any parts of the new bitmap falling outside the boundary of the master are cropped\&.
.PP
\fBParameters:\fP
.RS 4
\fIx\fP the pixel in the top-left corner of the new bitmap (coordinate \fI(0,0)\fP) is located at position \fI(x,y)\fP of the master bitmap 
.br
\fIy\fP (see parameter \fIx\fP) 
.br
\fIw\fP the width of the new bitmap, in pixels 
.br
\fIh\fP the height of the new bitmap, in pixels 
.br
\fIb\fP the new bitmap, as a one-dimensional array 
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBBitmapError\fP\fP if this is called after method \fC\fBfreeze()\fP\fP 
.RE
.PP

.PP
References debug, and Util::verbosity_\&.
.PP
Referenced by main()\&.
.SS "void Bitmap::rule (const intx, const inty, const intw, const inth)\fBBitmapError\fP"

.PP
Draws on the master bitmap a block (a `rule' in TeX terms) of height h and width w pixels\&. The bottom left corner of the rule occupies pixel (x,y) on the master bitmap\&.
.PP
\fBParameters:\fP
.RS 4
\fIx\fP the (pixel in the) bottom-left corner of the rule is located at position \fI(x,y)\fP of the master bitmap 
.br
\fIy\fP (see parameter \fIx\fP) 
.br
\fIw\fP the width of the new rule, in pixels 
.br
\fIh\fP the height of the new rule, in pixels 
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBBitmapError\fP\fP if this is called after method \fC\fBfreeze()\fP\fP 
.RE
.PP

.PP
References normal, and Util::verbosity_\&.
.PP
Referenced by main()\&.
.SS "void Bitmap::scaleDown (const intfactor)\fBBitmapError\fP"

.PP
Scales down the bitmap by a numerical factor\&. The resulting bitmap has a linear dimension smaller than the original by the given factor\&. The pixels in the resulting bitmap are resampled so that this gives a basic anti-aliasing effect\&.
.PP
We throw an exception if you try to scale down an empty bitmap, simply on the grounds that this is probably an error, and you want to know about it\&.
.PP
Freezes the bitmap as a side-effect\&.
.PP
\fBParameters:\fP
.RS 4
\fIfactor\fP the scaling factor, in the range 2\&.\&.8 
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBBitmapError\fP\fP if the scaling factor is outside the range 2\&.\&.8, or if the bitmap is empty 
.RE
.PP

.PP
References normal, DviFile::unit_pixels, and Util::verbosity_\&.
.PP
Referenced by main()\&.
.SS "void Bitmap::setDefaultRGB (const boolfg, const \fBBitmapColour\fP *rgb)\fC [static]\fP"

.PP
Sets the default foreground or background colours\&. This is just like \fCsetRGB\fP, except that it applies to all bitmaps subsequently created by this class\&.
.PP
\fBParameters:\fP
.RS 4
\fIfg\fP if true, sets the foreground colour; if false, the background 
.br
\fIrgb\fP the colour the ground is set to 
.RE
.PP

.PP
References Bitmap::BitmapColour_s::blue, Bitmap::BitmapColour_s::green, normal, and Bitmap::BitmapColour_s::red\&.
.PP
Referenced by main()\&.
.SS "void Bitmap::setRGB (const boolfg, const \fBBitmapColour\fP *rgb)"

.PP
Sets the foreground or background colour\&. 
.PP
\fBParameters:\fP
.RS 4
\fIfg\fP if true, sets the foreground colour; if false, the background 
.br
\fIrgb\fP the colour the ground is set to 
.RE
.PP

.PP
References Bitmap::BitmapColour_s::blue, Bitmap::BitmapColour_s::green, normal, and Bitmap::BitmapColour_s::red\&.
.PP
Referenced by main()\&.
.SS "void Bitmap::setTransparent (const boolsw)\fC [inline]\fP"

.PP
Sets the current bitmap to be transparent, if possible\&. 
.PP
\fBParameters:\fP
.RS 4
\fIsw\fP if true, the current bitmap is set to be transparent 
.RE
.PP

.PP
Referenced by main()\&.
.SS "void Bitmap::strut (const intx, const inty, const intl, const intr, const intt, const intb)\fBBitmapError\fP"

.PP
Draws a `strut' on the master bitmap\&. This is essentially the same as the \fC\fBrule()\fP\fP method, except that it doesn't draw in any pixels\&. Its only effect is to make sure that the boundingbox includes at least the \fIx\fP-values \fI[x-l,x+r-1]\fP, and the \fIy\fP-values \fI[y-t+1,y+b]\fP\&. That is, the area indicated by the strut is \fCl+r\fP pixels wide by \fCt+b\fP pixels deep\&. The parameters l, r, t, and b must all be non-negative\&. This implies that the call \fCrule(x, y, w, h)\fP has the same effect on the bounding box as \fCrule(x, y, 0, w, h, 0)\fP\&.
.PP
\fBParameters:\fP
.RS 4
\fIx\fP the x-coordinate of the reference point of the strut 
.br
\fIy\fP the y-coordinate of the reference point of the strut 
.br
\fIl\fP bounding box must be leftwards of \fCx-l\fP 
.br
\fIr\fP bounding box must be rightwards of \fCx+r\fP 
.br
\fIt\fP bounding box must be above \fCy-t\fP 
.br
\fIb\fP bounding box must be below \fCy+b\fP 
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBBitmapError\fP\fP if this is called after method \fC\fBfreeze()\fP\fP, or if one of l, r, t, b is negative 
.RE
.PP

.PP
References normal, and Util::verbosity_\&.
.PP
Referenced by main()\&.
.SS "static \fBverbosities\fP Bitmap::verbosity (const \fBverbosities\fPlevel)\fC [inline]\fP, \fC [static]\fP"

.PP
Sets the verbosity of the current class\&. 
.PP
\fBParameters:\fP
.RS 4
\fIlevel\fP the required verbosity 
.RE
.PP
\fBReturns:\fP
.RS 4
the previous verbosity level 
.RE
.PP

.PP
Referenced by main()\&.
.SS "void Bitmap::write (const stringfilename, const stringformat)\fBBitmapError\fP"

.PP
Writes the bitmap out to the specified file\&. The \fCformat\fP parameter specifies the format of this file, and should be one of the bitmap types listed in the sequence starting with \fBBitmapImage#firstBitmapImageFormat\fP; if this is not available, we try writing out in the default format, and if that fails in turn (something is clearly badly wrong) we throw an error\&.
.PP
Freezes the bitmap as a side-effect\&.
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP the name of the output filename 
.br
\fIformat\fP one of the format names known to class \fC\fBBitmapImage\fP\fP 
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBBitmapError\fP\fP if we cannot write out a bitmap even in the default format 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBBitmapImage\fP 
.RE
.PP

.PP
References BitmapImage::fileExtension(), BitmapImage::firstBitmapImageFormat(), DviFilePosition::getX(), DviFilePosition::getY(), BitmapImage::newBitmapImage(), normal, BitmapImage::setBitmap(), BitmapImage::setBitmapRow(), BitmapImage::setRGB(), BitmapImage::setTransparent(), DviFile::unit_pixels, Util::verbosity_, and BitmapImage::write()\&.
.PP
Referenced by main()\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBBitmap::const_iterator\fP Bitmap::endIterator_\fC [static]\fP"

.PP
Referenced by end()\&.
.SS "\fBconst_iterator\fP Bitmap::runningIterator_"

.PP
Referenced by begin()\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for dvi2bitmap from the source code\&.