| | 1 | .\" |
| | 2 | .\" Copyright (c) 1988-1997 Sam Leffler |
| | 3 | .\" Copyright (c) 1991-1997 Silicon Graphics, Inc. |
| | 4 | .\" |
| | 5 | .\" Permission to use, copy, modify, distribute, and sell this software and |
| | 6 | .\" its documentation for any purpose is hereby granted without fee, provided |
| | 7 | .\" that (i) the above copyright notices and this permission notice appear in |
| | 8 | .\" all copies of the software and related documentation, and (ii) the names of |
| | 9 | .\" Sam Leffler and Silicon Graphics may not be used in any advertising or |
| | 10 | .\" publicity relating to the software without the specific, prior written |
| | 11 | .\" permission of Sam Leffler and Silicon Graphics. |
| | 12 | .\" |
| | 13 | .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, |
| | 14 | .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY |
| | 15 | .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. |
| | 16 | .\" |
| | 17 | .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR |
| | 18 | .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, |
| | 19 | .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, |
| | 20 | .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF |
| | 21 | .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE |
| | 22 | .\" OF THIS SOFTWARE. |
| | 23 | .\" |
| | 24 | .if n .po 0 |
| | 25 | .TH TIFFWriteTile 3TIFF "November 29, 1999" "libtiff" |
| | 26 | .SH NAME |
| | 27 | TIFFWriteTile \- encode and write a tile of data to an open |
| | 28 | .SM TIFF |
| | 29 | file |
| | 30 | .SH SYNOPSIS |
| | 31 | .B "#include <tiffio.h>" |
| | 32 | .sp |
| | 33 | .BI "tsize_t TIFFWriteTile(TIFF *" tif ", tdata_t " buf ", uint32 " x ", uint32 " y ", uint32 " z ", tsample_t " sample ")" |
| | 34 | .SH DESCRIPTION |
| | 35 | Write the data for the tile |
| | 36 | .I containing |
| | 37 | the specified coordinates. The data in |
| | 38 | .I buf |
| | 39 | are is (potentially) compressed, and written to the indicated file, normally |
| | 40 | being appended to the end of the file. The buffer must be contain an entire |
| | 41 | tile of data. Applications should call the routine |
| | 42 | .IR TIFFTileSize |
| | 43 | to find out the size (in bytes) of a tile buffer. The |
| | 44 | .I x |
| | 45 | and |
| | 46 | .I y |
| | 47 | parameters are always used by |
| | 48 | .IR TIFFWriteTile . |
| | 49 | The |
| | 50 | .I z |
| | 51 | parameter is used if the image is deeper than 1 slice (\c |
| | 52 | .IR ImageDepth >1). |
| | 53 | The |
| | 54 | .I sample |
| | 55 | parameter is used only if data are organized in separate planes (\c |
| | 56 | .IR PlanarConfiguration =2). |
| | 57 | .SH "RETURN VALUES" |
| | 58 | .IR TIFFWriteTile |
| | 59 | returns \-1 if it detects an error; otherwise the number of bytes in the tile |
| | 60 | is returned. |
| | 61 | .SH DIAGNOSTICS |
| | 62 | All error messages are directed to the |
| | 63 | .BR TIFFError (3TIFF) |
| | 64 | routine. |
| | 65 | .SH "SEE ALSO" |
| | 66 | .BR TIFFCheckTile (3TIFF), |
| | 67 | .BR TIFFComputeTile (3TIFF), |
| | 68 | .BR TIFFOpen (3TIFF), |
| | 69 | .BR TIFFReadTile (3TIFF), |
| | 70 | .BR TIFFWriteScanline (3TIFF), |
| | 71 | .BR TIFFWriteEncodedTile (3TIFF), |
| | 72 | .BR TIFFWriteRawTile (3TIFF), |
| | 73 | .BR libtiff (3TIFF) |
| | 74 | .PP |
| | 75 | Libtiff library home page: |
| | 76 | .BR http://www.remotesensing.org/libtiff/ |
projects / wxWidgets.git / blame_incremental