[wxWidgets.git] / src / tiff / html / man / TIFFtile.3tiff.html

<!-- Creator     : groff version 1.18.1 -->
<!-- CreationDate: Mon Mar 13 18:03:11 2006 -->
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta name="Content-Style" content="text/css">
<title>TIFFTILE</title>
</head>
<body>

<h1 align=center>TIFFTILE</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>

<hr>
<a name="NAME"></a>
<h2>NAME</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p>TIFFTileSize, TIFFTileRowSize, TIFFVTileSize,
TIFFDefaultTileSize, TIFFComputeTile, TIFFCheckTile,
TIFFNumberOfTiles &minus; tile-related utility routines</p>
</td>
</table>
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p><b>#include &lt;tiffio.h&gt;</b></p>
<!-- INDENTATION -->
<p><b>void TIFFDefaultTileSize(TIFF *</b><i>tif</i><b>,
uint32 *</b><i>tw</i><b>, uint32 *</b><i>th</i><b>)<br>
tsize_t TIFFTileSize(TIFF *</b><i>tif</i><b>)<br>
tsize_t TIFFTileRowSize(TIFF *</b><i>tif</i><b>)<br>
tsize_t TIFFVTileSize(TIFF *</b><i>tif</i><b>, uint32</b>
<i>nrows</i><b>)<br>
ttile_t TIFFComputeTile(TIFF *</b><i>tif</i><b>, uint32</b>
<i>x</i><b>, uint32</b> <i>y</i><b>, uint32</b> <i>z</i><b>,
tsample_t</b> <i>sample</i><b>)<br>
int TIFFCheckTile(TIFF *</b><i>tif</i><b>, uint32</b>
<i>x</i><b>, uint32</b> <i>y</i><b>, uint32</b> <i>z</i><b>,
tsample_t</b> <i>sample</i><b>)<br>
ttile_t TIFFNumberOfTiles(TIFF *</b><i>tif</i><b>)</b></p>
</td>
</table>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p><i>TIFFDefaultTileSize</i> returns the pixel width and
height of a reasonable-sized tile; suitable for setting up
the <i>TileWidth</i> and <i>TileLength</i> tags. If the
<i>tw</i> and <i>th</i> values passed in are non-zero, then
they are adjusted to reflect any compression-specific
requirements. The returned width and height are constrained
to be a multiple of 16 pixels to conform with the
<small>TIFF</small> specification.</p>
<!-- INDENTATION -->
<p><i>TIFFTileSize</i> returns the equivalent size for a
tile of data as it would be returned in a call to
<i>TIFFReadTile</i> or as it would be expected in a call to
<i>TIFFWriteTile</i>.</p>
<!-- INDENTATION -->
<p><i>TIFFVTileSize</i> returns the number of bytes in a
row-aligned tile with <i>nrows</i> of data.</p>
<!-- INDENTATION -->
<p><i>TIFFTileRowSize</i> returns the number of bytes of a
row of data in a tile.</p>
<!-- INDENTATION -->
<p><i>TIFFComputeTile</i> returns the tile that contains the
specified coordinates. A valid tile is always returned;
out-of-range coordinate values are clamped to the bounds of
the image. The <i>x</i> and <i>y</i> parameters are always
used in calculating a tile. The <i>z</i> parameter is used
if the image is deeper than 1 slice
(<i>ImageDepth</i>&gt;1). The <i>sample</i> parameter is
used only if data are organized in separate planes
(<i>PlanarConfiguration</i>=2).</p>
<!-- INDENTATION -->
<p><i>TIFFCheckTile</i> returns a non-zero value if the
supplied coordinates are within the bounds of the image and
zero otherwise. The <i>x</i> parameter is checked against
the value of the <i>ImageWidth</i> tag. The <i>y</i>
parameter is checked against the value of the
<i>ImageLength</i> tag. The <i>z</i> parameter is checked
against the value of the <i>ImageDepth</i> tag (if defined).
The <i>sample</i> parameter is checked against the value of
the <i>SamplesPerPixel</i> parameter if the data are
organized in separate planes.</p>
<!-- INDENTATION -->
<p><i>TIFFNumberOfTiles</i> returns the number of tiles in
the image.</p>
</td>
</table>
<a name="DIAGNOSTICS"></a>
<h2>DIAGNOSTICS</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p>None.</p>
</td>
</table>
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p><b>TIFFReadEncodedTile</b>(3TIFF),
<b>TIFFReadRawTile</b>(3TIFF), <b>TIFFReadTile</b>(3TIFF),
<b>TIFFWriteEncodedTile</b>(3TIFF),
<b>TIFFWriteRawTile</b>(3TIFF), <b>TIFFWriteTile</b>(3TIFF),
<b>libtiff</b>(3TIFF)</p>
<!-- INDENTATION -->
<p>Libtiff library home page:
<b>http://www.remotesensing.org/libtiff/</b></p>
</td>
</table>
<hr>
</body>
</html>
Commit	Line	Data
8414a40c VZ	1	<!-- Creator : groff version 1.18.1 -->
	2	<!-- CreationDate: Mon Mar 13 18:03:11 2006 -->
	3	<html>
	4	<head>
	5	<meta name="generator" content="groff -Thtml, see www.gnu.org">
	6	<meta name="Content-Style" content="text/css">
	7	<title>TIFFTILE</title>
	8	</head>
	9	<body>
	10
	11	<h1 align=center>TIFFTILE</h1>
	12	<a href="#NAME">NAME</a><br>
	13	<a href="#SYNOPSIS">SYNOPSIS</a><br>
	14	<a href="#DESCRIPTION">DESCRIPTION</a><br>
	15	<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
	16	<a href="#SEE ALSO">SEE ALSO</a><br>
	17
	18	<hr>
	19	<a name="NAME"></a>
	20	<h2>NAME</h2>
	21	<!-- INDENTATION -->
	22	<table width="100%" border=0 rules="none" frame="void"
	23	cols="2" cellspacing="0" cellpadding="0">
	24	<tr valign="top" align="left">
	25	<td width="8%"></td>
	26	<td width="91%">
	27	<p>TIFFTileSize, TIFFTileRowSize, TIFFVTileSize,
	28	TIFFDefaultTileSize, TIFFComputeTile, TIFFCheckTile,
	29	TIFFNumberOfTiles − tile-related utility routines</p>
	30	</td>
	31	</table>
	32	<a name="SYNOPSIS"></a>
	33	<h2>SYNOPSIS</h2>
	34	<!-- INDENTATION -->
	35	<table width="100%" border=0 rules="none" frame="void"
	36	cols="2" cellspacing="0" cellpadding="0">
	37	<tr valign="top" align="left">
	38	<td width="8%"></td>
	39	<td width="91%">
	40	<p><b>#include <tiffio.h></b></p>
	41	<!-- INDENTATION -->
	42	<p><b>void TIFFDefaultTileSize(TIFF *</b><i>tif</i><b>,
	43	uint32 </b><i>tw</i><b>, uint32 </b><i>th</i><b>)<br>
	44	tsize_t TIFFTileSize(TIFF *</b><i>tif</i><b>)<br>
	45	tsize_t TIFFTileRowSize(TIFF *</b><i>tif</i><b>)<br>
	46	tsize_t TIFFVTileSize(TIFF *</b><i>tif</i><b>, uint32</b>
	47	<i>nrows</i><b>)<br>
	48	ttile_t TIFFComputeTile(TIFF *</b><i>tif</i><b>, uint32</b>
	49	<i>x</i><b>, uint32</b> <i>y</i><b>, uint32</b> <i>z</i><b>,
	50	tsample_t</b> <i>sample</i><b>)<br>
	51	int TIFFCheckTile(TIFF *</b><i>tif</i><b>, uint32</b>
	52	<i>x</i><b>, uint32</b> <i>y</i><b>, uint32</b> <i>z</i><b>,
	53	tsample_t</b> <i>sample</i><b>)<br>
	54	ttile_t TIFFNumberOfTiles(TIFF *</b><i>tif</i><b>)</b></p>
	55	</td>
	56	</table>
	57	<a name="DESCRIPTION"></a>
	58	<h2>DESCRIPTION</h2>
	59	<!-- INDENTATION -->
	60	<table width="100%" border=0 rules="none" frame="void"
	61	cols="2" cellspacing="0" cellpadding="0">
	62	<tr valign="top" align="left">
	63	<td width="8%"></td>
	64	<td width="91%">
65	<p><i>TIFFDefaultTileSize</i> returns the pixel width and
66	height of a reasonable-sized tile; suitable for setting up
67	the <i>TileWidth</i> and <i>TileLength</i> tags. If the
68	<i>tw</i> and <i>th</i> values passed in are non-zero, then
69	they are adjusted to reflect any compression-specific
70	requirements. The returned width and height are constrained
71	to be a multiple of 16 pixels to conform with the
72	<small>TIFF</small> specification.</p>
73	<!-- INDENTATION -->
74	<p><i>TIFFTileSize</i> returns the equivalent size for a
75	tile of data as it would be returned in a call to
76	<i>TIFFReadTile</i> or as it would be expected in a call to
77	<i>TIFFWriteTile</i>.</p>
78	<!-- INDENTATION -->
79	<p><i>TIFFVTileSize</i> returns the number of bytes in a
80	row-aligned tile with <i>nrows</i> of data.</p>
81	<!-- INDENTATION -->
82	<p><i>TIFFTileRowSize</i> returns the number of bytes of a
83	row of data in a tile.</p>
84	<!-- INDENTATION -->
85	<p><i>TIFFComputeTile</i> returns the tile that contains the
86	specified coordinates. A valid tile is always returned;
87	out-of-range coordinate values are clamped to the bounds of
88	the image. The <i>x</i> and <i>y</i> parameters are always
89	used in calculating a tile. The <i>z</i> parameter is used
90	if the image is deeper than 1 slice
91	(<i>ImageDepth</i>>1). The <i>sample</i> parameter is
92	used only if data are organized in separate planes
93	(<i>PlanarConfiguration</i>=2).</p>
94	<!-- INDENTATION -->
95	<p><i>TIFFCheckTile</i> returns a non-zero value if the
96	supplied coordinates are within the bounds of the image and
97	zero otherwise. The <i>x</i> parameter is checked against
98	the value of the <i>ImageWidth</i> tag. The <i>y</i>
99	parameter is checked against the value of the
100	<i>ImageLength</i> tag. The <i>z</i> parameter is checked
101	against the value of the <i>ImageDepth</i> tag (if defined).
102	The <i>sample</i> parameter is checked against the value of
103	the <i>SamplesPerPixel</i> parameter if the data are
104	organized in separate planes.</p>
105	<!-- INDENTATION -->
106	<p><i>TIFFNumberOfTiles</i> returns the number of tiles in
107	the image.</p>
108	</td>
109	</table>
110	<a name="DIAGNOSTICS"></a>
111	<h2>DIAGNOSTICS</h2>
112	<!-- INDENTATION -->
113	<table width="100%" border=0 rules="none" frame="void"
114	cols="2" cellspacing="0" cellpadding="0">
115	<tr valign="top" align="left">
116	<td width="8%"></td>
117	<td width="91%">
118	<p>None.</p>
119	</td>
120	</table>
121	<a name="SEE ALSO"></a>
122	<h2>SEE ALSO</h2>
123	<!-- INDENTATION -->
124	<table width="100%" border=0 rules="none" frame="void"
125	cols="2" cellspacing="0" cellpadding="0">
126	<tr valign="top" align="left">
127	<td width="8%"></td>
128	<td width="91%">
129	<p><b>TIFFReadEncodedTile</b>(3TIFF),
130	<b>TIFFReadRawTile</b>(3TIFF), <b>TIFFReadTile</b>(3TIFF),
131	<b>TIFFWriteEncodedTile</b>(3TIFF),
132	<b>TIFFWriteRawTile</b>(3TIFF), <b>TIFFWriteTile</b>(3TIFF),
133	<b>libtiff</b>(3TIFF)</p>
134	<!-- INDENTATION -->
135	<p>Libtiff library home page:
136	<b>http://www.remotesensing.org/libtiff/</b></p>
137	</td>
138	</table>
139	<hr>
140	</body>
141	</html>