通讯编程

开发平台：
Visual C++

FindPhoto.3：源码内容
							'"
'" Copyright (c) 1994 The Australian National University
'" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'"
'" See the file "license.terms" for information on usage and redistribution
'" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'" 
'" Author: Paul Mackerras (paulus@cs.anu.edu.au),
'"	    Department of Computer Science,
'"	    Australian National University.
'"
'" RCS: @(#) $Id: FindPhoto.3,v 1.6 2002/08/05 04:30:38 dgp Exp $
'"
.so man.macros
.TH Tk_FindPhoto 3 8.0 Tk "Tk Library Procedures"
.BS
.SH NAME
Tk_FindPhoto, Tk_PhotoPutBlock, Tk_PhotoPutZoomedBlock, Tk_PhotoGetImage, Tk_PhotoBlank, Tk_PhotoExpand, Tk_PhotoGetSize, Tk_PhotoSetSize - manipulate the image data stored in a photo image.
.SH SYNOPSIS
.nf
fB#include <tk.h>fR
fB#include <tkPhoto.h>fR
.sp
Tk_PhotoHandle
.VS 8.0 br
fBTk_FindPhotofR(fIinterp, imageNamefR)
.VE
.sp
void
fBTk_PhotoPutBlockfR(fIhandle, blockPtr, x, y, width, height, compRulefR)
.sp
void
fBTk_PhotoPutZoomedBlockfR(fIhandle, blockPtr, x, y, width, height,
zoomX, zoomY, subsampleX, subsampleY, compRulefR)
.sp
int
fBTk_PhotoGetImagefR(fIhandle, blockPtrfR)
.sp
void
fBTk_PhotoBlankfR(fIhandlefR)
.sp
void
fBTk_PhotoExpandfR(fIhandle, width, heightfR)
.sp
void
fBTk_PhotoGetSizefR(fIhandle, widthPtr, heightPtrfR)
.sp
void
fBTk_PhotoSetSizefR(fIhandle, width, heightfR)
.SH ARGUMENTS
.AS Tk_PhotoImageBlock window_path
.AP Tcl_Interp *interp in
.VS
Interpreter in which image was created.
.VE
.AP "CONST char" *imageName in
Name of the photo image.
.AP Tk_PhotoHandle handle in
Opaque handle identifying the photo image to be affected.
.AP Tk_PhotoImageBlock *blockPtr in
Specifies the address and storage layout of image data.
.AP int x in
Specifies the X coordinate where the top-left corner of the block is
to be placed within the image.
.AP int y in
Specifies the Y coordinate where the top-left corner of the block is
to be placed within the image.
.AP int width in
Specifies the width of the image area to be affected (for
fBTk_PhotoPutBlockfR) or the desired image width (for
fBTk_PhotoExpandfR and fBTk_PhotoSetSizefR).
.VS 8.4
.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
of the existing photo image, with the previous contents showing
through in the transparent bits) or TK_PHOTO_COMPOSITE_SET (which
discards the existing photo image contents in the rectangle covered by
the data block.)
.VE 8.4
.AP int height in
Specifies the height of the image area to be affected (for
fBTk_PhotoPutBlockfR) or the desired image height (for
fBTk_PhotoExpandfR and fBTk_PhotoSetSizefR).
.AP int *widthPtr out
Pointer to location in which to store the image width.
.AP int *heightPtr out
Pointer to location in which to store the image height.
.AP int subsampleX in
Specifies the subsampling factor in the X direction for input
image data.
.AP int subsampleY in
Specifies the subsampling factor in the Y direction for input
image data.
.AP int zoomX in
Specifies the zoom factor to be applied in the X direction to pixels
being written to the photo image.
.AP int zoomY in
Specifies the zoom factor to be applied in the Y direction to pixels
being written to the photo image.
.BE
.SH DESCRIPTION
.PP
fBTk_FindPhotofR returns an opaque handle that is used to identify a
particular photo image to the other procedures.  The parameter is the
name of the image, that is, the name specified to the fBimage create
photofR command, or assigned by that command if no name was specified.
.PP
fBTk_PhotoPutBlockfR is used to supply blocks of image data to be
displayed.  The call affects an area of the image of size
fIwidthfR x fIheightfR pixels, with its top-left corner at
coordinates (fIxfR,fIyfR).  All of fIwidthfR, fIheightfR,
fIxfR, and fIyfR must be non-negative.
If part of this area lies outside the
current bounds of the image, the image will be expanded to include the
area, unless the user has specified an explicit image size with the
fB-widthfR and/or fB-heightfR widget configuration options
(see photo(n)); in that
case the area is silently clipped to the image boundaries.
.PP
The fIblockfR parameter is a pointer to a
fBTk_PhotoImageBlockfR structure, defined as follows:
.CS
typedef struct {
	unsigned char *fIpixelPtrfR;
	int fIwidthfR;
	int fIheightfR;
	int fIpitchfR;
	int fIpixelSizefR;
	int fIoffset[4]fR;
} Tk_PhotoImageBlock;
.CE
The fIpixelPtrfR field points to the first pixel, that is, the
top-left pixel in the block.
The fIwidthfR and fIheightfR fields specify the dimensions of the
block of pixels.  The fIpixelSizefR field specifies the address
difference between two horizontally adjacent pixels.  Often it is 3
or 4, but it can have any value.  The fIpitchfR field specifies the
address difference between two vertically adjacent pixels.  The
fIoffsetfR array contains the offsets from the address of a pixel
to the addresses of the bytes containing the red, green, blue and alpha
(transparency) components.  These are normally 0, 1, 2 and 3, but can
have other values, e.g., for images that are stored as separate red,
green and blue planes.
.PP
.VS 8.4
The fIcompRulefR parameter to fBTk_PhotoPutBlockfR specifies a
compositing rule that says what to do with transparent pixels.  The
value TK_PHOTO_COMPOSITE_OVERLAY 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
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.
.VE 8.4
.PP
The value given for the fIwidthfR and fIheightfR parameters to
fBTk_PhotoPutBlockfR do not have to correspond to the values specified
in fIblockfR.  If they are smaller, fBTk_PhotoPutBlockfR extracts a
sub-block from the image data supplied.  If they are larger, the data
given are replicated (in a tiled fashion) to fill the specified area.
These rules operate independently in the horizontal and vertical
directions.
.PP
fBTk_PhotoPutZoomedBlockfR works like fBTk_PhotoPutBlockfR except that
the image can be reduced or enlarged for display.  The
fIsubsampleXfR and fIsubsampleYfR parameters allow the size of the
image to be reduced by subsampling.
fBTk_PhotoPutZoomedBlockfR will use only pixels from the input image
whose X coordinates are multiples of fIsubsampleXfR, and whose Y
coordinates are multiples of fIsubsampleYfR.  For example, an image
of 512x512 pixels can be reduced to 256x256 by setting
fIsubsampleXfR and fIsubsampleYfR to 2.
.PP
The fIzoomXfR and fIzoomYfR parameters allow the image to be
enlarged by pixel replication.  Each pixel of the (possibly subsampled)
input image will be written to a block fIzoomXfR pixels wide and
fIzoomYfR pixels high of the displayed image.  Subsampling and
zooming can be used together for special effects.
.PP
fBTk_PhotoGetImagefR can be used to retrieve image data from a photo
image.  fBTk_PhotoGetImagefR fills
in the structure pointed to by the fIblockPtrfR parameter with values
that describe the address and layout of the image data that the
photo image has stored internally.  The values are valid
until the image is destroyed or its size is changed.
fBTk_PhotoGetImagefR returns 1 for compatibility with the
corresponding procedure in the old photo widget.
.PP
fBTk_PhotoBlankfR blanks the entire area of the
photo image.  Blank areas of a photo image are transparent.
.PP
fBTk_PhotoExpandfR requests that the widget's image be expanded to be
at least fIwidthfR x fIheightfR pixels in size.  The width and/or
height are unchanged if the user has specified an explicit image width
or height with the fB-widthfR and/or fB-heightfR configuration
options, respectively.
If the image data
are being supplied in many small blocks, it is more efficient to use
fBTk_PhotoExpandfR or fBTk_PhotoSetSizefR at the beginning rather than
allowing the image to expand in many small increments as image blocks
are supplied.
.PP
fBTk_PhotoSetSizefR specifies the size of the image, as if the user
had specified the given fIwidthfR and fIheightfR values to the
fB-widthfR and fB-heightfR configuration options.  A value of
zero for fIwidthfR or fIheightfR does not change the image's width
or height, but allows the width or height to be changed by subsequent
calls to fBTk_PhotoPutBlockfR, fBTk_PhotoPutZoomedBlockfR or
fBTk_PhotoExpandfR.
.PP
fBTk_PhotoGetSizefR returns the dimensions of the image in
*fIwidthPtrfR and *fIheightPtrfR.
.SH PORTABILITY
.VS 8.4
.PP
In Tk 8.3 and earlier, fBTk_PhotoPutBlockfR and
fBTk_PhotoPutZoomedBlockfR had different signatures. If you want to
compile code that uses the old interface against 8.4 without updating
your code, compile it with the flag
-DUSE_COMPOSITELESS_PHOTO_PUT_BLOCK.  Code linked using Stubs against
older versions of Tk will continue to work.
.VE 8.4
.SH CREDITS
.PP
The code for the photo image type was developed by Paul Mackerras,
based on his earlier photo widget code.
.SH KEYWORDS
photo, image

						