Blame man/TIFFtile.3tiff

Packit 7838c8
.\" $Id: TIFFtile.3tiff,v 1.3 2016-09-25 20:05:51 bfriesen Exp $
Packit 7838c8
.\"
Packit 7838c8
.\" Copyright (c) 1988-1997 Sam Leffler
Packit 7838c8
.\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
Packit 7838c8
.\"
Packit 7838c8
.\" Permission to use, copy, modify, distribute, and sell this software and 
Packit 7838c8
.\" its documentation for any purpose is hereby granted without fee, provided
Packit 7838c8
.\" that (i) the above copyright notices and this permission notice appear in
Packit 7838c8
.\" all copies of the software and related documentation, and (ii) the names of
Packit 7838c8
.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
Packit 7838c8
.\" publicity relating to the software without the specific, prior written
Packit 7838c8
.\" permission of Sam Leffler and Silicon Graphics.
Packit 7838c8
.\" 
Packit 7838c8
.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
Packit 7838c8
.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
Packit 7838c8
.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
Packit 7838c8
.\" 
Packit 7838c8
.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
Packit 7838c8
.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
Packit 7838c8
.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
Packit 7838c8
.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
Packit 7838c8
.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
Packit 7838c8
.\" OF THIS SOFTWARE.
Packit 7838c8
.\"
Packit 7838c8
.if n .po 0
Packit 7838c8
.TH TIFFTILE 3TIFF "February 14, 1992" "libtiff"
Packit 7838c8
.SH NAME
Packit 7838c8
TIFFTileSize, TIFFTileRowSize, TIFFVTileSize, TIFFDefaultTileSize,
Packit 7838c8
TIFFComputeTile, TIFFCheckTile, TIFFNumberOfTiles \- tile-related utility
Packit 7838c8
routines
Packit 7838c8
.SH SYNOPSIS
Packit 7838c8
.B "#include <tiffio.h>"
Packit 7838c8
.sp
Packit 7838c8
.BI "void TIFFDefaultTileSize(TIFF *" tif ", uint32 *" tw ", uint32 *" th ")"
Packit 7838c8
.br
Packit 7838c8
.BI "tsize_t TIFFTileSize(TIFF *" tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "tsize_t TIFFTileRowSize(TIFF *" tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "tsize_t TIFFVTileSize(TIFF *" tif ", uint32 " nrows ")"
Packit 7838c8
.br
Packit 7838c8
.BI "ttile_t TIFFComputeTile(TIFF *" tif ", uint32 " x ", uint32 " y ", uint32 " z ", tsample_t " sample ")"
Packit 7838c8
.br
Packit 7838c8
.BI "int TIFFCheckTile(TIFF *" tif ", uint32 " x ", uint32 " y ", uint32 " z ", tsample_t " sample ")"
Packit 7838c8
.br
Packit 7838c8
.BI "ttile_t TIFFNumberOfTiles(TIFF *" tif ")"
Packit 7838c8
.br
Packit 7838c8
.SH DESCRIPTION
Packit 7838c8
.I TIFFDefaultTileSize
Packit 7838c8
returns the pixel width and height of a reasonable-sized tile; suitable for
Packit 7838c8
setting up the
Packit 7838c8
.I TileWidth
Packit 7838c8
and
Packit 7838c8
.I TileLength
Packit 7838c8
tags.
Packit 7838c8
If the
Packit 7838c8
.I tw
Packit 7838c8
and
Packit 7838c8
.I th
Packit 7838c8
values passed in are non-zero, then they are adjusted to reflect any
Packit 7838c8
compression-specific requirements. The returned width and height are
Packit 7838c8
constrained to be a multiple of 16 pixels to conform with the 
Packit 7838c8
.SM TIFF
Packit 7838c8
specification.
Packit 7838c8
.PP
Packit 7838c8
.I TIFFTileSize
Packit 7838c8
returns the equivalent size for a tile of data as it would be returned in a
Packit 7838c8
call to
Packit 7838c8
.I TIFFReadTile
Packit 7838c8
or as it would be expected in a call to
Packit 7838c8
.IR TIFFWriteTile .
Packit 7838c8
.PP
Packit 7838c8
.I TIFFVTileSize
Packit 7838c8
returns the number of bytes in a row-aligned tile with
Packit 7838c8
.I nrows
Packit 7838c8
of data.
Packit 7838c8
.PP
Packit 7838c8
.I TIFFTileRowSize
Packit 7838c8
returns the number of bytes of a row of data in a tile.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFComputeTile
Packit 7838c8
returns the tile that contains the specified coordinates. A valid tile is
Packit 7838c8
always returned; out-of-range coordinate values are clamped to the bounds of
Packit 7838c8
the image. The
Packit 7838c8
.I x
Packit 7838c8
and
Packit 7838c8
.I y
Packit 7838c8
parameters are always used in calculating a tile. The
Packit 7838c8
.I z
Packit 7838c8
parameter is used if the image is deeper than 1 slice (\c
Packit 7838c8
.IR ImageDepth >1).
Packit 7838c8
The
Packit 7838c8
.I sample
Packit 7838c8
parameter is used only if data are organized in separate planes (\c
Packit 7838c8
.IR PlanarConfiguration =2).
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFCheckTile
Packit 7838c8
returns a non-zero value if the supplied coordinates are within the bounds of
Packit 7838c8
the image and zero otherwise. The
Packit 7838c8
.I x
Packit 7838c8
parameter is checked against the value of the
Packit 7838c8
.I ImageWidth
Packit 7838c8
tag. The
Packit 7838c8
.I y
Packit 7838c8
parameter is checked against the value of the
Packit 7838c8
.I ImageLength
Packit 7838c8
tag. The
Packit 7838c8
.I z
Packit 7838c8
parameter is checked against the value of the
Packit 7838c8
.I ImageDepth
Packit 7838c8
tag (if defined). The
Packit 7838c8
.I sample
Packit 7838c8
parameter is checked against the value of the
Packit 7838c8
.I SamplesPerPixel
Packit 7838c8
parameter if the data are organized in separate planes.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFNumberOfTiles
Packit 7838c8
returns the number of tiles in the image.
Packit 7838c8
.SH DIAGNOSTICS
Packit 7838c8
None.
Packit 7838c8
.SH "SEE ALSO"
Packit 7838c8
.BR TIFFReadEncodedTile (3TIFF),
Packit 7838c8
.BR TIFFReadRawTile (3TIFF),
Packit 7838c8
.BR TIFFReadTile (3TIFF),
Packit 7838c8
.BR TIFFWriteEncodedTile (3TIFF),
Packit 7838c8
.BR TIFFWriteRawTile (3TIFF),
Packit 7838c8
.BR TIFFWriteTile (3TIFF),
Packit 7838c8
.BR libtiff (3TIFF)
Packit 7838c8
.PP
Packit 7838c8
Libtiff library home page:
Packit 7838c8
.BR http://www.simplesystems.org/libtiff/