src/tiff/man/TIFFtile.3tiff

   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 TIFFTILE 3TIFF "February 14, 1992" "libtiff"
  26 .SH NAME
  27 TIFFTileSize, TIFFTileRowSize, TIFFVTileSize, TIFFDefaultTileSize,
  28 TIFFComputeTile, TIFFCheckTile, TIFFNumberOfTiles \- tile-related utility
  29 routines
  30 .SH SYNOPSIS
  31 .B "#include <tiffio.h>"
  32 .sp
  33 .BI "void TIFFDefaultTileSize(TIFF *" tif ", uint32 *" tw ", uint32 *" th ")"
  34 .br
  35 .BI "tsize_t TIFFTileSize(TIFF *" tif ")"
  36 .br
  37 .BI "tsize_t TIFFTileRowSize(TIFF *" tif ")"
  38 .br
  39 .BI "tsize_t TIFFVTileSize(TIFF *" tif ", uint32 " nrows ")"
  40 .br
  41 .BI "ttile_t TIFFComputeTile(TIFF *" tif ", uint32 " x ", uint32 " y ", uint32 " z ", tsample_t " sample ")"
  42 .br
  43 .BI "int TIFFCheckTile(TIFF *" tif ", uint32 " x ", uint32 " y ", uint32 " z ", tsample_t " sample ")"
  44 .br
  45 .BI "ttile_t TIFFNumberOfTiles(TIFF *" tif ")"
  46 .br
  47 .SH DESCRIPTION
  48 .I TIFFDefaultTileSize
  49 returns the pixel width and height of a reasonable-sized tile; suitable for
  50 setting up the
  51 .I TileWidth
  52 and
  53 .I TileLength
  54 tags.
  55 If the
  56 .I tw
  57 and
  58 .I th
  59 values passed in are non-zero, then they are adjusted to reflect any
  60 compression-specific requirements. The returned width and height are
  61 constrained to be a multiple of 16 pixels to conform with the
  62 .SM TIFF
  63 specification.
  64 .PP
  65 .I TIFFTileSize
  66 returns the equivalent size for a tile of data as it would be returned in a
  67 call to
  68 .I TIFFReadTile
  69 or as it would be expected in a call to
  70 .IR TIFFWriteTile .
  71 .PP
  72 .I TIFFVTileSize
  73 returns the number of bytes in a row-aligned tile with
  74 .I nrows
  75 of data.
  76 .PP
  77 .I TIFFTileRowSize
  78 returns the number of bytes of a row of data in a tile.
  79 .PP
  80 .IR TIFFComputeTile
  81 returns the tile that contains the specified coordinates. A valid tile is
  82 always returned; out-of-range coordinate values are clamped to the bounds of
  83 the image. The
  84 .I x
  85 and
  86 .I y
  87 parameters are always used in calculating a tile. The
  88 .I z
  89 parameter is used if the image is deeper than 1 slice (\c
  90 .IR ImageDepth >1).
  91 The
  92 .I sample
  93 parameter is used only if data are organized in separate planes (\c
  94 .IR PlanarConfiguration =2).
  95 .PP
  96 .IR TIFFCheckTile
  97 returns a non-zero value if the supplied coordinates are within the bounds of
  98 the image and zero otherwise. The
  99 .I x
 100 parameter is checked against the value of the
 101 .I ImageWidth
 102 tag. The
 103 .I y
 104 parameter is checked against the value of the
 105 .I ImageLength
 106 tag. The
 107 .I z
 108 parameter is checked against the value of the
 109 .I ImageDepth
 110 tag (if defined). The
 111 .I sample
 112 parameter is checked against the value of the
 113 .I SamplesPerPixel
 114 parameter if the data are organized in separate planes.
 115 .PP
 116 .IR TIFFNumberOfTiles
 117 returns the number of tiles in the image.
 118 .SH DIAGNOSTICS
 119 None.
 120 .SH "SEE ALSO"
 121 .BR TIFFReadEncodedTile (3TIFF),
 122 .BR TIFFReadRawTile (3TIFF),
 123 .BR TIFFReadTile (3TIFF),
 124 .BR TIFFWriteEncodedTile (3TIFF),
 125 .BR TIFFWriteRawTile (3TIFF),
 126 .BR TIFFWriteTile (3TIFF),
 127 .BR libtiff (3TIFF)
 128 .PP
 129 Libtiff library home page:
 130 .BR http://www.remotesensing.org/libtiff/