.TH "PkGlyph" 3 "Mon Jan 12 2015" "Version dvi2bitmap1.0" "dvi2bitmap" \" -*- nroff -*- .ad l .nh .SH NAME PkGlyph \- .SH SYNOPSIS .br .PP .PP \fC#include \fP .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBPkGlyph\fP (unsigned int cc, unsigned int tfmwidth, unsigned int dm, unsigned int \fBw\fP, unsigned int \fBh\fP, int \fBhoff\fP, int \fBvoff\fP, \fBPkRasterdata\fP *rasterdata, \fBPkFont\fP *f)" .br .RI "\fIRepresents a single glyph in a font\&. \fP" .ti -1c .RI "\fBPkGlyph\fP (unsigned int cc, unsigned int tfmwidth, unsigned int dx, unsigned int dy, unsigned int \fBw\fP, unsigned int \fBh\fP, int \fBhoff\fP, int \fBvoff\fP, \fBPkRasterdata\fP *rasterdata, \fBPkFont\fP *f)" .br .RI "\fIRepresents a single glyph in a font\&. \fP" .ti -1c .RI "\fBPkGlyph\fP (int \fBresolution\fP, \fBPkFont\fP *f)" .br .RI "\fIConstructs a dummy glyph for a font\&. \fP" .ti -1c .RI "unsigned int \fBcharacterCode\fP () const " .br .RI "\fIThe character code for this glyph\&. \fP" .ti -1c .RI "char \fBcharacterChar\fP () const " .br .RI "\fIThe character which this glyph represents\&. \fP" .ti -1c .RI "const \fBByte\fP * \fBbitmap\fP ()" .br .RI "\fIReturns the bitmap which represents this glyph\&. \fP" .ti -1c .RI "unsigned int \fBw\fP () const " .br .RI "\fIWidth of this character\&. \fP" .ti -1c .RI "unsigned int \fBh\fP () const " .br .RI "\fIHeight of this character\&. \fP" .ti -1c .RI "int \fBhoff\fP () const " .br .RI "\fIObtains the horizontal offset of the first pixel of the bitmap from the reference point for this glyph, with positive numbers indicating a rightward offset\&. \fP" .ti -1c .RI "int \fBvoff\fP () const " .br .RI "\fIObtains the vertical offset of the first pixel of the bitmap from the reference point for this glyph, with positive numbers indicating a downward offset (which is rather rare, since the reference point is generally near the lower-left corner of the glyph)\&. \fP" .ti -1c .RI "double \fBtfmWidth\fP () const " .br .RI "\fIThe glyph's width\&. \fP" .ti -1c .RI "int \fBhEscapement\fP () const " .br .RI "\fIThe glyph's horizontal escapement\&. \fP" .ti -1c .RI "int \fBvEscapement\fP () const " .br .RI "\fIThe glyph's vertical escapement\&. \fP" .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBverbosities\fP \fBverbosity\fP (const \fBverbosities\fP level)" .br .RI "\fISets the verbosity of this module\&. \fP" .in -1c .SH "Constructor & Destructor Documentation" .PP .SS "PkGlyph::PkGlyph (unsigned intcc, unsigned inttfmwidth, unsigned intdm, unsigned intw, unsigned inth, inthoff, intvoff, \fBPkRasterdata\fP *rasterdata, \fBPkFont\fP *f)" .PP Represents a single glyph in a font\&. The parameters here correspond to the parameters of the same names which are read from the PK file\&. .PP \fBParameters:\fP .RS 4 \fIcc\fP the character code of this glyph .br \fItfmwidth\fP the width of the character, in DVI units .br \fIdm\fP the horizontal escapement, in pixels; this is the number of pixels rightwards (towards increasing \fIx\fP) that the reference should move after this glyph is set; the vertical escapement is taken to be zero .br \fIw\fP width of the bitmap in pixels .br \fIh\fP height of the bitmap in pixels .br \fIhoff\fP \fI(hoff,voff)\fP is the position of the glyph reference point, as an offset from the top-left pixel, in units of pixels, and with right and down being positive .br \fIvoff\fP see parameter \fChoff\fP .br \fIrasterdata\fP the raster information for this glyph .br \fIf\fP the font which this glyph belongs to .RE .PP .PP References PkFont::designSize\&. .SS "PkGlyph::PkGlyph (unsigned intcc, unsigned inttfmwidth, unsigned intdx, unsigned intdy, unsigned intw, unsigned inth, inthoff, intvoff, \fBPkRasterdata\fP *rasterdata, \fBPkFont\fP *f)" .PP Represents a single glyph in a font\&. The parameters here correspond to the parameters of the same names which are read from the PK file\&. .PP \fBParameters:\fP .RS 4 \fIcc\fP the character code of this glyph .br \fItfmwidth\fP the width of the character, in DVI units .br \fIdx\fP the horizontal escapement, in pixels times 2**16; this defines the number of pixels rightwards (towards increasing \fIx\fP) that the reference should move after this glyph is set .br \fIdy\fP the vertical escapement, in pixels times 2**16 .br \fIw\fP width of the bitmap in pixels .br \fIh\fP height of the bitmap in pixels .br \fIhoff\fP \fI(hoff,voff)\fP is the position of the glyph reference point, as an offset from the top-left pixel, in units of pixels, and with right and down being positive .br \fIvoff\fP see parameter \fChoff\fP .br \fIrasterdata\fP the raster information for this glyph .br \fIf\fP the font which this glyph belongs to .RE .PP .PP References PkFont::designSize\&. .SS "PkGlyph::PkGlyph (intresolution, \fBPkFont\fP *f)" .PP Constructs a dummy glyph for a font\&. .PP \fBParameters:\fP .RS 4 \fIresolution\fP the resolution which this glyph corresponds to .br \fIf\fP the font which this glyph is a member of .RE .PP .PP References PkFont::designSize\&. .SH "Member Function Documentation" .PP .SS "const \fBByte\fP * PkGlyph::bitmap ()" .PP Returns the bitmap which represents this glyph\&. This runs from the top-left of the character, with the width and height as given by methods \fC\fBw()\fP\fP and \fC\fBh()\fP\fP\&. .PP \fBReturns:\fP .RS 4 the bitmap for this glyph .RE .PP .PP References PkRasterdata::bitmap()\&. .PP Referenced by main()\&. .SS "char PkGlyph::characterChar () const\fC [inline]\fP" .PP The character which this glyph represents\&. .PP \fBReturns:\fP .RS 4 the (ASCII) printable character which this glyph purports to represent .RE .PP .PP Referenced by main()\&. .SS "unsigned int PkGlyph::characterCode () const\fC [inline]\fP" .PP The character code for this glyph\&. .PP Referenced by main()\&. .SS "unsigned int PkGlyph::h () const\fC [inline]\fP" .PP Height of this character\&. This is the number of columns in the bitmap returned by method \fC\fBbitmap()\fP\fP .PP \fBReturns:\fP .RS 4 height in device units (ie, pixels) .RE .PP .PP Referenced by main()\&. .SS "int PkGlyph::hEscapement () const\fC [inline]\fP" .PP The glyph's horizontal escapement\&. .PP \fBReturns:\fP .RS 4 the escapement in pixels .RE .PP .SS "int PkGlyph::hoff () const\fC [inline]\fP" .PP Obtains the horizontal offset of the first pixel of the bitmap from the reference point for this glyph, with positive numbers indicating a rightward offset\&. This is the negative of the horizontal offset of the reference point from the bitmap, as discussed in \fBthe constructor\fP\&. .PP \fBReturns:\fP .RS 4 the offset (in pixels, with right being positive) .RE .PP .PP Referenced by main()\&. .SS "double PkGlyph::tfmWidth () const\fC [inline]\fP" .PP The glyph's width\&. .PP \fBReturns:\fP .RS 4 the glyph's width in points .RE .PP .SS "static \fBverbosities\fP PkGlyph::verbosity (const \fBverbosities\fPlevel)\fC [inline]\fP, \fC [static]\fP" .PP Sets the verbosity of this module\&. .PP \fBParameters:\fP .RS 4 \fIlevel\fP the required verbosity .RE .PP \fBReturns:\fP .RS 4 the previous verbosity level .RE .PP .SS "int PkGlyph::vEscapement () const\fC [inline]\fP" .PP The glyph's vertical escapement\&. .PP \fBReturns:\fP .RS 4 the escapement in pixels .RE .PP .SS "int PkGlyph::voff () const\fC [inline]\fP" .PP Obtains the vertical offset of the first pixel of the bitmap from the reference point for this glyph, with positive numbers indicating a downward offset (which is rather rare, since the reference point is generally near the lower-left corner of the glyph)\&. This is the negative of the vertical offset of the reference point from the bitmap, as discussed in \fBthe constructor\fP\&. .PP \fBReturns:\fP .RS 4 the offset (in pixels, with down being positive) .RE .PP .PP Referenced by main()\&. .SS "unsigned int PkGlyph::w () const\fC [inline]\fP" .PP Width of this character\&. This is the row-length of the bitmap returned by method \fC\fBbitmap()\fP\fP .PP \fBReturns:\fP .RS 4 width in device units (ie, pixels) .RE .PP .PP Referenced by main()\&. .SH "Author" .PP Generated automatically by Doxygen for dvi2bitmap from the source code\&.