[wxWidgets.git] / src / tiff / man / TIFFWriteEncodedTile.3tiff

.\"
.\" Copyright (c) 1988-1997 Sam Leffler
.\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
.\"
.\" Permission to use, copy, modify, distribute, and sell this software and 
.\" its documentation for any purpose is hereby granted without fee, provided
.\" that (i) the above copyright notices and this permission notice appear in
.\" all copies of the software and related documentation, and (ii) the names of
.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
.\" publicity relating to the software without the specific, prior written
.\" permission of Sam Leffler and Silicon Graphics.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
.\" 
.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
.\" OF THIS SOFTWARE.
.\"
.if n .po 0
.TH TIFFWriteEncodedTile 3TIFF "December 16, 1991" "libtiff"
.SH NAME
TIFFWritedEncodedTile \- compress and write a tile of data to an open
.SM TIFF
file
.SH SYNOPSIS
.B "#include <tiffio.h>"
.sp
.BI "tsize_t TIFFWriteEncodedTile(TIFF *" tif ", ttile_t " tile ", tdata_t " buf ", tsize_t " size ")"
.SH DESCRIPTION
Compress
.I size
bytes of raw data from
.I buf
and
.B append
the result to the end of the specified tile. Note that the value of
.I tile
is a ``raw tile number.'' That is, the caller must take into account whether
or not the data are organized in separate places (\c
.IR PlanarConfiguration =2).
.IR TIFFComputeTile
automatically does this when converting an (x,y,z,sample) coordinate quadruple
to a tile number.
.SH NOTES
The library writes encoded data using the native machine byte order. Correctly
implemented
.SM TIFF
readers are expected to do any necessary byte-swapping to correctly process
image data with BitsPerSample greater than 8.
.SH "RETURN VALUES"
\-1 is returned if an error was encountered. Otherwise, the value of
.IR size 
is returned.
.SH DIAGNOSTICS
All error messages are directed to the
.BR TIFFError (3TIFF)
routine.
.PP
\fB%s: File not open for writing\fP.
The file was opened for reading, not writing.
.PP
\fBCan not write tiles to a stripped image\fP.
The image is assumed to be organized in strips because neither of the
.I TileWidth
or
.I TileLength
tags have been set with
.BR TIFFSetField (3TIFF).
.PP
\fB%s: Must set "ImageWidth" before writing data\fP. The image's width has not
be set before the first write. See
.BR TIFFSetField (3TIFF)
for information on how to do this.
.PP
\fB%s: Must set "PlanarConfiguration" before writing data\fP. The organization
of data has not be defined before the first write. See
.BR TIFFSetField (3TIFF)
for information on how to do this.
.PP
\fB%s: No space for tile arrays"\fP.
There was not enough space for the arrays that hold tile offsets and byte
counts.
.SH "SEE ALSO"
.BR TIFFOpen (3TIFF),
.BR TIFFWriteTile (3TIFF),
.BR TIFFWriteRawTile (3TIFF),
.BR libtiff (3TIFF)
.PP
Libtiff library home page:
.BR http://www.remotesensing.org/libtiff/
Commit	Line	Data
8414a40c VZ	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 TIFFWriteEncodedTile 3TIFF "December 16, 1991" "libtiff"
	26	.SH NAME
	27	TIFFWritedEncodedTile \- compress 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 TIFFWriteEncodedTile(TIFF *" tif ", ttile_t " tile ", tdata_t " buf ", tsize_t " size ")"
	34	.SH DESCRIPTION
	35	Compress
	36	.I size
	37	bytes of raw data from
	38	.I buf
	39	and
	40	.B append
	41	the result to the end of the specified tile. Note that the value of
	42	.I tile
	43	is a ``raw tile number.'' That is, the caller must take into account whether
	44	or not the data are organized in separate places (\c
	45	.IR PlanarConfiguration =2).
	46	.IR TIFFComputeTile
	47	automatically does this when converting an (x,y,z,sample) coordinate quadruple
	48	to a tile number.
	49	.SH NOTES
	50	The library writes encoded data using the native machine byte order. Correctly
	51	implemented
	52	.SM TIFF
	53	readers are expected to do any necessary byte-swapping to correctly process
	54	image data with BitsPerSample greater than 8.
	55	.SH "RETURN VALUES"
	56	\-1 is returned if an error was encountered. Otherwise, the value of
	57	.IR size
	58	is returned.
	59	.SH DIAGNOSTICS
	60	All error messages are directed to the
	61	.BR TIFFError (3TIFF)
	62	routine.
	63	.PP
	64	\fB%s: File not open for writing\fP.
65	The file was opened for reading, not writing.
66	.PP
67	\fBCan not write tiles to a stripped image\fP.
68	The image is assumed to be organized in strips because neither of the
69	.I TileWidth
70	or
71	.I TileLength
72	tags have been set with
73	.BR TIFFSetField (3TIFF).
74	.PP
75	\fB%s: Must set "ImageWidth" before writing data\fP. The image's width has not
76	be set before the first write. See
77	.BR TIFFSetField (3TIFF)
78	for information on how to do this.
79	.PP
80	\fB%s: Must set "PlanarConfiguration" before writing data\fP. The organization
81	of data has not be defined before the first write. See
82	.BR TIFFSetField (3TIFF)
83	for information on how to do this.
84	.PP
85	\fB%s: No space for tile arrays"\fP.
86	There was not enough space for the arrays that hold tile offsets and byte
87	counts.
88	.SH "SEE ALSO"
89	.BR TIFFOpen (3TIFF),
90	.BR TIFFWriteTile (3TIFF),
91	.BR TIFFWriteRawTile (3TIFF),
92	.BR libtiff (3TIFF)
93	.PP
94	Libtiff library home page:
95	.BR http://www.remotesensing.org/libtiff/