summaryrefslogtreecommitdiffstats
path: root/Doc/libimageop.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/libimageop.tex')
-rw-r--r--Doc/libimageop.tex28
1 files changed, 13 insertions, 15 deletions
diff --git a/Doc/libimageop.tex b/Doc/libimageop.tex
index 4a93487..c21be48 100644
--- a/Doc/libimageop.tex
+++ b/Doc/libimageop.tex
@@ -1,16 +1,14 @@
-\section{Built-in Module \sectcode{imageop}}
+\section{Built-in Module \module{imageop}}
\label{module-imageop}
\bimodindex{imageop}
-The \code{imageop} module contains some useful operations on images.
-It operates on images consisting of 8 or 32 bit pixels
-stored in Python strings. This is the same format as used
-by \code{gl.lrectwrite} and the \code{imgfile} module.
+The \module{imageop} module contains some useful operations on images.
+It operates on images consisting of 8 or 32 bit pixels stored in
+Python strings. This is the same format as used by
+\function{gl.lrectwrite()} and the \module{imgfile} module.
The module defines the following variables and functions:
-\setindexsubitem{(in module imageop)}
-
\begin{excdesc}{error}
This exception is raised on all errors, such as unknown number of bits
per pixel, etc.
@@ -21,11 +19,11 @@ per pixel, etc.
Return the selected part of \var{image}, which should by
\var{width} by \var{height} in size and consist of pixels of
\var{psize} bytes. \var{x0}, \var{y0}, \var{x1} and \var{y1} are like
-the \code{lrectread} parameters, i.e.\ the boundary is included in the
-new image. The new boundaries need not be inside the picture. Pixels
-that fall outside the old image will have their value set to zero. If
-\var{x0} is bigger than \var{x1} the new image is mirrored. The same
-holds for the y coordinates.
+the \function{gl.lrectread()} parameters, i.e.\ the boundary is
+included in the new image. The new boundaries need not be inside the
+picture. Pixels that fall outside the old image will have their value
+set to zero. If \var{x0} is bigger than \var{x1} the new image is
+mirrored. The same holds for the y coordinates.
\end{funcdesc}
\begin{funcdesc}{scale}{image, psize, width, height, newwidth, newheight}
@@ -46,7 +44,7 @@ interlacing, hence the name.
\begin{funcdesc}{grey2mono}{image, width, height, threshold}
Convert a 8-bit deep greyscale image to a 1-bit deep image by
tresholding all the pixels. The resulting image is tightly packed and
-is probably only useful as an argument to \code{mono2grey}.
+is probably only useful as an argument to \function{mono2grey()}.
\end{funcdesc}
\begin{funcdesc}{dither2mono}{image, width, height}
@@ -74,8 +72,8 @@ dithering.
\begin{funcdesc}{dither2grey2}{image, width, height}
Convert an 8-bit greyscale image to a 2-bit greyscale image with
-dithering. As for \code{dither2mono}, the dithering algorithm is
-currently very simple.
+dithering. As for \function{dither2mono()}, the dithering algorithm
+is currently very simple.
\end{funcdesc}
\begin{funcdesc}{grey42grey}{image, width, height}