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

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