summaryrefslogtreecommitdiffstats
path: root/doc/FindPhoto.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-09-19 16:05:34 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-09-19 16:05:34 (GMT)
commit9d13fb1cb472be80ac1cea698fcc91be991b0ac4 (patch)
tree83898b60ed6e9f9dd9a2b525a9ad32172a88d4fc /doc/FindPhoto.3
parent50324a159a264c9d34c81d447b4926ea75e2cb45 (diff)
downloadtk-9d13fb1cb472be80ac1cea698fcc91be991b0ac4.zip
tk-9d13fb1cb472be80ac1cea698fcc91be991b0ac4.tar.gz
tk-9d13fb1cb472be80ac1cea698fcc91be991b0ac4.tar.bz2
Standardize style of section refs & public symbols. Remove displayed tabs
Diffstat (limited to 'doc/FindPhoto.3')
-rw-r--r--doc/FindPhoto.336
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/FindPhoto.3 b/doc/FindPhoto.3
index bebf5d8..1b8387b 100644
--- a/doc/FindPhoto.3
+++ b/doc/FindPhoto.3
@@ -9,7 +9,7 @@
'\" Department of Computer Science,
'\" Australian National University.
'\"
-'\" RCS: @(#) $Id: FindPhoto.3,v 1.8 2003/11/21 17:10:39 dkf Exp $
+'\" RCS: @(#) $Id: FindPhoto.3,v 1.9 2004/09/19 16:05:36 dkf Exp $
'\"
.so man.macros
.TH Tk_FindPhoto 3 8.0 Tk "Tk Library Procedures"
@@ -75,9 +75,9 @@ Specifies the width of the image area to be affected (for
.AP int compRule in
Specifies the compositing rule used when combining transparent pixels
in a block of data with a photo image. Must be one of
-TK_PHOTO_COMPOSITE_OVERLAY (which puts the block of data over the top
+\fBTK_PHOTO_COMPOSITE_OVERLAY\fR (which puts the block of data over the top
of the existing photo image, with the previous contents showing
-through in the transparent bits) or TK_PHOTO_COMPOSITE_SET (which
+through in the transparent bits) or \fBTK_PHOTO_COMPOSITE_SET\fR (which
discards the existing photo image contents in the rectangle covered by
the data block.)
.AP int height in
@@ -125,12 +125,12 @@ The \fIblock\fR parameter is a pointer to a
\fBTk_PhotoImageBlock\fR structure, defined as follows:
.CS
typedef struct {
- unsigned char *\fIpixelPtr\fR;
- int \fIwidth\fR;
- int \fIheight\fR;
- int \fIpitch\fR;
- int \fIpixelSize\fR;
- int \fIoffset[4]\fR;
+ unsigned char *\fIpixelPtr\fR;
+ int \fIwidth\fR;
+ int \fIheight\fR;
+ int \fIpitch\fR;
+ int \fIpixelSize\fR;
+ int \fIoffset[4]\fR;
} Tk_PhotoImageBlock;
.CE
The \fIpixelPtr\fR field points to the first pixel, that is, the
@@ -148,12 +148,12 @@ green and blue planes.
.PP
The \fIcompRule\fR parameter to \fBTk_PhotoPutBlock\fR specifies a
compositing rule that says what to do with transparent pixels. The
-value TK_PHOTO_COMPOSITE_OVERLAY says that the previous contents of
+value \fBTK_PHOTO_COMPOSITE_OVERLAY\fR says that the previous contents of
the photo image should show through, and the value
-TK_PHOTO_COMPOSITE_SET says that the previous contents of the photo
+\fBTK_PHOTO_COMPOSITE_SET\fR says that the previous contents of the photo
image should be completely ignored, and the values from the block be
copied directly across. The behavior in Tk8.3 and earlier was
-equivalent to having TK_PHOTO_COMPOSITE_OVERLAY as a compositing rule.
+equivalent to having \fBTK_PHOTO_COMPOSITE_OVERLAY\fR as a compositing rule.
.PP
The value given for the \fIwidth\fR and \fIheight\fR parameters to
\fBTk_PhotoPutBlock\fR do not have to correspond to the values specified
@@ -164,8 +164,8 @@ These rules operate independently in the horizontal and vertical
directions.
.PP
.VS 8.5
-\fBTk_PhotoPutBlock\fR normally returns TCL_OK, though if it cannot
-allocate sufficient memory to hold the resulting image, TCL_ERROR is
+\fBTk_PhotoPutBlock\fR normally returns \fBTCL_OK\fR, though if it cannot
+allocate sufficient memory to hold the resulting image, \fBTCL_ERROR\fR is
returned instead and, if the \fIinterp\fR argument is non-NULL, an
error message is placed in the interpreter's result.
.VE 8.5
@@ -210,8 +210,8 @@ allowing the image to expand in many small increments as image blocks
are supplied.
.PP
.VS 8.5
-\fBTk_PhotoExpand\fR normally returns TCL_OK, though if it cannot
-allocate sufficient memory to hold the resulting image, TCL_ERROR is
+\fBTk_PhotoExpand\fR normally returns \fBTCL_OK\fR, though if it cannot
+allocate sufficient memory to hold the resulting image, \fBTCL_ERROR\fR is
returned instead and, if the \fIinterp\fR argument is non-NULL, an
error message is placed in the interpreter's result.
.VE 8.5
@@ -225,8 +225,8 @@ calls to \fBTk_PhotoPutBlock\fR, \fBTk_PhotoPutZoomedBlock\fR or
\fBTk_PhotoExpand\fR.
.PP
.VS 8.5
-\fBTk_PhotoSetSize\fR normally returns TCL_OK, though if it cannot
-allocate sufficient memory to hold the resulting image, TCL_ERROR is
+\fBTk_PhotoSetSize\fR normally returns \fBTCL_OK\fR, though if it cannot
+allocate sufficient memory to hold the resulting image, \fBTCL_ERROR\fR is
returned instead and, if the \fIinterp\fR argument is non-NULL, an
error message is placed in the interpreter's result.
.VE 8.5