summaryrefslogtreecommitdiff
path: root/dviware/dvi2bitmap/doc_libdvi2bitmap/latex/classPkGlyph.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /dviware/dvi2bitmap/doc_libdvi2bitmap/latex/classPkGlyph.tex
Initial commit
Diffstat (limited to 'dviware/dvi2bitmap/doc_libdvi2bitmap/latex/classPkGlyph.tex')
-rw-r--r--dviware/dvi2bitmap/doc_libdvi2bitmap/latex/classPkGlyph.tex363
1 files changed, 363 insertions, 0 deletions
diff --git a/dviware/dvi2bitmap/doc_libdvi2bitmap/latex/classPkGlyph.tex b/dviware/dvi2bitmap/doc_libdvi2bitmap/latex/classPkGlyph.tex
new file mode 100644
index 0000000000..fa9dd7761c
--- /dev/null
+++ b/dviware/dvi2bitmap/doc_libdvi2bitmap/latex/classPkGlyph.tex
@@ -0,0 +1,363 @@
+\hypertarget{classPkGlyph}{\section{Pk\-Glyph Class Reference}
+\label{classPkGlyph}\index{Pk\-Glyph@{Pk\-Glyph}}
+}
+
+
+{\ttfamily \#include $<$Pk\-Font.\-h$>$}
+
+\subsection*{Public Member Functions}
+\begin{DoxyCompactItemize}
+\item
+\hyperlink{classPkGlyph_a9f813953a164decde2fa092fe58fb740}{Pk\-Glyph} (unsigned int cc, unsigned int tfmwidth, unsigned int dm, unsigned int \hyperlink{classPkGlyph_aa361202ae2241a1eb75c9d43870ada0f}{w}, unsigned int \hyperlink{classPkGlyph_a9e480e8db5b5689e396891db8209ef08}{h}, int \hyperlink{classPkGlyph_a12b67de9c3d10469bfcc2557a768c894}{hoff}, int \hyperlink{classPkGlyph_a7b08c0e501011de914ec0f5f96ae8d52}{voff}, \hyperlink{classPkRasterdata}{Pk\-Rasterdata} $\ast$rasterdata, \hyperlink{classPkFont}{Pk\-Font} $\ast$f)
+\begin{DoxyCompactList}\small\item\em Represents a single glyph in a font. \end{DoxyCompactList}\item
+\hyperlink{classPkGlyph_ac1c68cc40ee3b322fcfcd5905e95f513}{Pk\-Glyph} (unsigned int cc, unsigned int tfmwidth, unsigned int dx, unsigned int dy, unsigned int \hyperlink{classPkGlyph_aa361202ae2241a1eb75c9d43870ada0f}{w}, unsigned int \hyperlink{classPkGlyph_a9e480e8db5b5689e396891db8209ef08}{h}, int \hyperlink{classPkGlyph_a12b67de9c3d10469bfcc2557a768c894}{hoff}, int \hyperlink{classPkGlyph_a7b08c0e501011de914ec0f5f96ae8d52}{voff}, \hyperlink{classPkRasterdata}{Pk\-Rasterdata} $\ast$rasterdata, \hyperlink{classPkFont}{Pk\-Font} $\ast$f)
+\begin{DoxyCompactList}\small\item\em Represents a single glyph in a font. \end{DoxyCompactList}\item
+\hyperlink{classPkGlyph_abc9a1f15d41c28abb3465d5dc9963216}{Pk\-Glyph} (int \hyperlink{dvi2bitmap_8cc_a42e8863b58f9ee9bd3e23ed02cc63430}{resolution}, \hyperlink{classPkFont}{Pk\-Font} $\ast$f)
+\begin{DoxyCompactList}\small\item\em Constructs a dummy glyph for a font. \end{DoxyCompactList}\item
+unsigned int \hyperlink{classPkGlyph_a5914c943a28b46946463e0d35729e169}{character\-Code} () const
+\begin{DoxyCompactList}\small\item\em The character code for this glyph. \end{DoxyCompactList}\item
+char \hyperlink{classPkGlyph_a57d0cff1440ef13e2d4d0c72e53c1fdc}{character\-Char} () const
+\begin{DoxyCompactList}\small\item\em The character which this glyph represents. \end{DoxyCompactList}\item
+const \hyperlink{Byte_8h_ae3a497195d617519e5353ea7b417940f}{Byte} $\ast$ \hyperlink{classPkGlyph_a25423771a373cd8c8670b1fa6c79685b}{bitmap} ()
+\begin{DoxyCompactList}\small\item\em Returns the bitmap which represents this glyph. \end{DoxyCompactList}\item
+unsigned int \hyperlink{classPkGlyph_aa361202ae2241a1eb75c9d43870ada0f}{w} () const
+\begin{DoxyCompactList}\small\item\em Width of this character. \end{DoxyCompactList}\item
+unsigned int \hyperlink{classPkGlyph_a9e480e8db5b5689e396891db8209ef08}{h} () const
+\begin{DoxyCompactList}\small\item\em Height of this character. \end{DoxyCompactList}\item
+int \hyperlink{classPkGlyph_a12b67de9c3d10469bfcc2557a768c894}{hoff} () const
+\begin{DoxyCompactList}\small\item\em 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. \end{DoxyCompactList}\item
+int \hyperlink{classPkGlyph_a7b08c0e501011de914ec0f5f96ae8d52}{voff} () const
+\begin{DoxyCompactList}\small\item\em 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). \end{DoxyCompactList}\item
+double \hyperlink{classPkGlyph_a5fac41658d2fc74ff92daf3a46280cad}{tfm\-Width} () const
+\begin{DoxyCompactList}\small\item\em The glyph's width. \end{DoxyCompactList}\item
+int \hyperlink{classPkGlyph_a18c6ef7708159f1ea87847ccb0b1111e}{h\-Escapement} () const
+\begin{DoxyCompactList}\small\item\em The glyph's horizontal escapement. \end{DoxyCompactList}\item
+int \hyperlink{classPkGlyph_a2706ca6e2d34e877c98ab6cafcf4b5d4}{v\-Escapement} () const
+\begin{DoxyCompactList}\small\item\em The glyph's vertical escapement. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{Static Public Member Functions}
+\begin{DoxyCompactItemize}
+\item
+static \hyperlink{verbosity_8h_a886df075e73fd6d54e018791f87fa071}{verbosities} \hyperlink{classPkGlyph_a4c2c657014d11f96b24b0a30d60579c3}{verbosity} (const \hyperlink{verbosity_8h_a886df075e73fd6d54e018791f87fa071}{verbosities} level)
+\begin{DoxyCompactList}\small\item\em Sets the verbosity of this module. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{Constructor \& Destructor Documentation}
+\hypertarget{classPkGlyph_a9f813953a164decde2fa092fe58fb740}{\index{Pk\-Glyph@{Pk\-Glyph}!Pk\-Glyph@{Pk\-Glyph}}
+\index{Pk\-Glyph@{Pk\-Glyph}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{Pk\-Glyph}]{\setlength{\rightskip}{0pt plus 5cm}Pk\-Glyph\-::\-Pk\-Glyph (
+\begin{DoxyParamCaption}
+\item[{unsigned int}]{cc, }
+\item[{unsigned int}]{tfmwidth, }
+\item[{unsigned int}]{dm, }
+\item[{unsigned int}]{w, }
+\item[{unsigned int}]{h, }
+\item[{int}]{hoff, }
+\item[{int}]{voff, }
+\item[{{\bf Pk\-Rasterdata} $\ast$}]{rasterdata, }
+\item[{{\bf Pk\-Font} $\ast$}]{f}
+\end{DoxyParamCaption}
+)}}\label{classPkGlyph_a9f813953a164decde2fa092fe58fb740}
+
+
+Represents a single glyph in a font.
+
+The parameters here correspond to the parameters of the same names which are read from the P\-K file.
+
+
+\begin{DoxyParams}{Parameters}
+{\em cc} & the character code of this glyph \\
+\hline
+{\em tfmwidth} & the width of the character, in D\-V\-I units \\
+\hline
+{\em dm} & the horizontal escapement, in pixels; this is the number of pixels rightwards (towards increasing {\itshape x}) that the reference should move after this glyph is set; the vertical escapement is taken to be zero \\
+\hline
+{\em w} & width of the bitmap in pixels \\
+\hline
+{\em h} & height of the bitmap in pixels \\
+\hline
+{\em hoff} & {\itshape (hoff,voff)} 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 \\
+\hline
+{\em voff} & see parameter {\ttfamily hoff} \\
+\hline
+{\em rasterdata} & the raster information for this glyph \\
+\hline
+{\em f} & the font which this glyph belongs to \\
+\hline
+\end{DoxyParams}
+
+
+References Pk\-Font\-::design\-Size.
+
+\hypertarget{classPkGlyph_ac1c68cc40ee3b322fcfcd5905e95f513}{\index{Pk\-Glyph@{Pk\-Glyph}!Pk\-Glyph@{Pk\-Glyph}}
+\index{Pk\-Glyph@{Pk\-Glyph}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{Pk\-Glyph}]{\setlength{\rightskip}{0pt plus 5cm}Pk\-Glyph\-::\-Pk\-Glyph (
+\begin{DoxyParamCaption}
+\item[{unsigned int}]{cc, }
+\item[{unsigned int}]{tfmwidth, }
+\item[{unsigned int}]{dx, }
+\item[{unsigned int}]{dy, }
+\item[{unsigned int}]{w, }
+\item[{unsigned int}]{h, }
+\item[{int}]{hoff, }
+\item[{int}]{voff, }
+\item[{{\bf Pk\-Rasterdata} $\ast$}]{rasterdata, }
+\item[{{\bf Pk\-Font} $\ast$}]{f}
+\end{DoxyParamCaption}
+)}}\label{classPkGlyph_ac1c68cc40ee3b322fcfcd5905e95f513}
+
+
+Represents a single glyph in a font.
+
+The parameters here correspond to the parameters of the same names which are read from the P\-K file.
+
+
+\begin{DoxyParams}{Parameters}
+{\em cc} & the character code of this glyph \\
+\hline
+{\em tfmwidth} & the width of the character, in D\-V\-I units \\
+\hline
+{\em dx} & the horizontal escapement, in pixels times $2^{16}$; this defines the number of pixels rightwards (towards increasing {\itshape x}) that the reference should move after this glyph is set \\
+\hline
+{\em dy} & the vertical escapement, in pixels times $2^{16}$ \\
+\hline
+{\em w} & width of the bitmap in pixels \\
+\hline
+{\em h} & height of the bitmap in pixels \\
+\hline
+{\em hoff} & {\itshape (hoff,voff)} 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 \\
+\hline
+{\em voff} & see parameter {\ttfamily hoff} \\
+\hline
+{\em rasterdata} & the raster information for this glyph \\
+\hline
+{\em f} & the font which this glyph belongs to \\
+\hline
+\end{DoxyParams}
+
+
+References Pk\-Font\-::design\-Size.
+
+\hypertarget{classPkGlyph_abc9a1f15d41c28abb3465d5dc9963216}{\index{Pk\-Glyph@{Pk\-Glyph}!Pk\-Glyph@{Pk\-Glyph}}
+\index{Pk\-Glyph@{Pk\-Glyph}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{Pk\-Glyph}]{\setlength{\rightskip}{0pt plus 5cm}Pk\-Glyph\-::\-Pk\-Glyph (
+\begin{DoxyParamCaption}
+\item[{int}]{resolution, }
+\item[{{\bf Pk\-Font} $\ast$}]{f}
+\end{DoxyParamCaption}
+)}}\label{classPkGlyph_abc9a1f15d41c28abb3465d5dc9963216}
+
+
+Constructs a dummy glyph for a font.
+
+
+\begin{DoxyParams}{Parameters}
+{\em resolution} & the resolution which this glyph corresponds to \\
+\hline
+{\em f} & the font which this glyph is a member of \\
+\hline
+\end{DoxyParams}
+
+
+References Pk\-Font\-::design\-Size.
+
+
+
+\subsection{Member Function Documentation}
+\hypertarget{classPkGlyph_a25423771a373cd8c8670b1fa6c79685b}{\index{Pk\-Glyph@{Pk\-Glyph}!bitmap@{bitmap}}
+\index{bitmap@{bitmap}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{bitmap}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf Byte} $\ast$ Pk\-Glyph\-::bitmap (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+)}}\label{classPkGlyph_a25423771a373cd8c8670b1fa6c79685b}
+
+
+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 {\ttfamily \hyperlink{classPkGlyph_aa361202ae2241a1eb75c9d43870ada0f}{w()}} and {\ttfamily \hyperlink{classPkGlyph_a9e480e8db5b5689e396891db8209ef08}{h()}}. \begin{DoxyReturn}{Returns}
+the bitmap for this glyph
+\end{DoxyReturn}
+
+
+References Pk\-Rasterdata\-::bitmap().
+
+
+
+Referenced by main().
+
+\hypertarget{classPkGlyph_a57d0cff1440ef13e2d4d0c72e53c1fdc}{\index{Pk\-Glyph@{Pk\-Glyph}!character\-Char@{character\-Char}}
+\index{character\-Char@{character\-Char}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{character\-Char}]{\setlength{\rightskip}{0pt plus 5cm}char Pk\-Glyph\-::character\-Char (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classPkGlyph_a57d0cff1440ef13e2d4d0c72e53c1fdc}
+
+
+The character which this glyph represents.
+
+\begin{DoxyReturn}{Returns}
+the (A\-S\-C\-I\-I) printable character which this glyph purports to represent
+\end{DoxyReturn}
+
+
+Referenced by main().
+
+\hypertarget{classPkGlyph_a5914c943a28b46946463e0d35729e169}{\index{Pk\-Glyph@{Pk\-Glyph}!character\-Code@{character\-Code}}
+\index{character\-Code@{character\-Code}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{character\-Code}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int Pk\-Glyph\-::character\-Code (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classPkGlyph_a5914c943a28b46946463e0d35729e169}
+
+
+The character code for this glyph.
+
+
+
+Referenced by main().
+
+\hypertarget{classPkGlyph_a9e480e8db5b5689e396891db8209ef08}{\index{Pk\-Glyph@{Pk\-Glyph}!h@{h}}
+\index{h@{h}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{h}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int Pk\-Glyph\-::h (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classPkGlyph_a9e480e8db5b5689e396891db8209ef08}
+
+
+Height of this character.
+
+This is the number of columns in the bitmap returned by method {\ttfamily \hyperlink{classPkGlyph_a25423771a373cd8c8670b1fa6c79685b}{bitmap()}} \begin{DoxyReturn}{Returns}
+height in device units (ie, pixels)
+\end{DoxyReturn}
+
+
+Referenced by main().
+
+\hypertarget{classPkGlyph_a18c6ef7708159f1ea87847ccb0b1111e}{\index{Pk\-Glyph@{Pk\-Glyph}!h\-Escapement@{h\-Escapement}}
+\index{h\-Escapement@{h\-Escapement}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{h\-Escapement}]{\setlength{\rightskip}{0pt plus 5cm}int Pk\-Glyph\-::h\-Escapement (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classPkGlyph_a18c6ef7708159f1ea87847ccb0b1111e}
+
+
+The glyph's horizontal escapement.
+
+\begin{DoxyReturn}{Returns}
+the escapement in pixels
+\end{DoxyReturn}
+\hypertarget{classPkGlyph_a12b67de9c3d10469bfcc2557a768c894}{\index{Pk\-Glyph@{Pk\-Glyph}!hoff@{hoff}}
+\index{hoff@{hoff}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{hoff}]{\setlength{\rightskip}{0pt plus 5cm}int Pk\-Glyph\-::hoff (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classPkGlyph_a12b67de9c3d10469bfcc2557a768c894}
+
+
+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 \hyperlink{classPkGlyph}{the constructor}.
+
+\begin{DoxyReturn}{Returns}
+the offset (in pixels, with right being positive)
+\end{DoxyReturn}
+
+
+Referenced by main().
+
+\hypertarget{classPkGlyph_a5fac41658d2fc74ff92daf3a46280cad}{\index{Pk\-Glyph@{Pk\-Glyph}!tfm\-Width@{tfm\-Width}}
+\index{tfm\-Width@{tfm\-Width}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{tfm\-Width}]{\setlength{\rightskip}{0pt plus 5cm}double Pk\-Glyph\-::tfm\-Width (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classPkGlyph_a5fac41658d2fc74ff92daf3a46280cad}
+
+
+The glyph's width.
+
+\begin{DoxyReturn}{Returns}
+the glyph's width in points
+\end{DoxyReturn}
+\hypertarget{classPkGlyph_a4c2c657014d11f96b24b0a30d60579c3}{\index{Pk\-Glyph@{Pk\-Glyph}!verbosity@{verbosity}}
+\index{verbosity@{verbosity}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{verbosity}]{\setlength{\rightskip}{0pt plus 5cm}static {\bf verbosities} Pk\-Glyph\-::verbosity (
+\begin{DoxyParamCaption}
+\item[{const {\bf verbosities}}]{level}
+\end{DoxyParamCaption}
+)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}}\label{classPkGlyph_a4c2c657014d11f96b24b0a30d60579c3}
+
+
+Sets the verbosity of this module.
+
+
+\begin{DoxyParams}{Parameters}
+{\em level} & the required verbosity \\
+\hline
+\end{DoxyParams}
+\begin{DoxyReturn}{Returns}
+the previous verbosity level
+\end{DoxyReturn}
+\hypertarget{classPkGlyph_a2706ca6e2d34e877c98ab6cafcf4b5d4}{\index{Pk\-Glyph@{Pk\-Glyph}!v\-Escapement@{v\-Escapement}}
+\index{v\-Escapement@{v\-Escapement}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{v\-Escapement}]{\setlength{\rightskip}{0pt plus 5cm}int Pk\-Glyph\-::v\-Escapement (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classPkGlyph_a2706ca6e2d34e877c98ab6cafcf4b5d4}
+
+
+The glyph's vertical escapement.
+
+\begin{DoxyReturn}{Returns}
+the escapement in pixels
+\end{DoxyReturn}
+\hypertarget{classPkGlyph_a7b08c0e501011de914ec0f5f96ae8d52}{\index{Pk\-Glyph@{Pk\-Glyph}!voff@{voff}}
+\index{voff@{voff}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{voff}]{\setlength{\rightskip}{0pt plus 5cm}int Pk\-Glyph\-::voff (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classPkGlyph_a7b08c0e501011de914ec0f5f96ae8d52}
+
+
+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 \hyperlink{classPkGlyph}{the constructor}.
+
+\begin{DoxyReturn}{Returns}
+the offset (in pixels, with down being positive)
+\end{DoxyReturn}
+
+
+Referenced by main().
+
+\hypertarget{classPkGlyph_aa361202ae2241a1eb75c9d43870ada0f}{\index{Pk\-Glyph@{Pk\-Glyph}!w@{w}}
+\index{w@{w}!PkGlyph@{Pk\-Glyph}}
+\subsubsection[{w}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int Pk\-Glyph\-::w (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classPkGlyph_aa361202ae2241a1eb75c9d43870ada0f}
+
+
+Width of this character.
+
+This is the row-\/length of the bitmap returned by method {\ttfamily \hyperlink{classPkGlyph_a25423771a373cd8c8670b1fa6c79685b}{bitmap()}} \begin{DoxyReturn}{Returns}
+width in device units (ie, pixels)
+\end{DoxyReturn}
+
+
+Referenced by main().
+
+
+
+The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
+\item
+\hyperlink{PkFont_8h}{Pk\-Font.\-h}\item
+\hyperlink{PkFont_8cc}{Pk\-Font.\-cc}\end{DoxyCompactItemize}