| | 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 QUERY 3TIFF "October 29, 2004" "libtiff" |
| | 26 | .SH NAME |
| | 27 | TIFFCurrentRow, |
| | 28 | TIFFCurrentStrip, |
| | 29 | TIFFCurrentTile, |
| | 30 | TIFFCurrentDirectory, |
| | 31 | TIFFLastDirectory, |
| | 32 | TIFFFileno, |
| | 33 | TIFFFileName, |
| | 34 | TIFFGetMode, |
| | 35 | TIFFIsTiled, |
| | 36 | TIFFIsByteSwapped, |
| | 37 | TIFFIsUpSampled, |
| | 38 | TIFFIsMSB2LSB, |
| | 39 | TIFFGetVersion |
| | 40 | \- query routines |
| | 41 | .SH SYNOPSIS |
| | 42 | .B "#include <tiffio.h>" |
| | 43 | .sp |
| | 44 | .BI "uint32 TIFFCurrentRow(TIFF* " tif ")" |
| | 45 | .br |
| | 46 | .BI "tstrip_t TIFFCurrentStrip(TIFF* " tif ")" |
| | 47 | .br |
| | 48 | .BI "ttile_t TIFFCurrentTile(TIFF* " tif ")" |
| | 49 | .br |
| | 50 | .BI "tdir_t TIFFCurrentDirectory(TIFF* " tif ")" |
| | 51 | .br |
| | 52 | .BI "int TIFFLastDirectory(TIFF* " tif ")" |
| | 53 | .br |
| | 54 | .BI "int TIFFFileno(TIFF* " tif ")" |
| | 55 | .br |
| | 56 | .BI "char* TIFFFileName(TIFF* " tif ")" |
| | 57 | .br |
| | 58 | .BI "int TIFFGetMode(TIFF* " tif ")" |
| | 59 | .br |
| | 60 | .BI "int TIFFIsTiled(TIFF* " tif ")" |
| | 61 | .br |
| | 62 | .BI "int TIFFIsByteSwapped(TIFF* " tif ")" |
| | 63 | .br |
| | 64 | .BI "int TIFFIsUpSampled(TIFF* " tif ")" |
| | 65 | .br |
| | 66 | .BI "int TIFFIsMSB2LSB(TIFF* " tif ")" |
| | 67 | .br |
| | 68 | .BI "const char* TIFFGetVersion(void)" |
| | 69 | .SH DESCRIPTION |
| | 70 | The following routines return status information about an open |
| | 71 | .SM TIFF |
| | 72 | file. |
| | 73 | .PP |
| | 74 | .IR TIFFCurrentDirectory |
| | 75 | returns the index of the current directory (directories are numbered starting |
| | 76 | at 0). This number is suitable for use with the |
| | 77 | .IR TIFFSetDirectory |
| | 78 | routine. |
| | 79 | .PP |
| | 80 | .IR TIFFLastDirectory |
| | 81 | returns a non-zero value if the current directory is the last directory in the |
| | 82 | file; otherwise zero is returned. |
| | 83 | .PP |
| | 84 | .IR TIFFCurrentRow , |
| | 85 | .IR TIFFCurrentStrip , |
| | 86 | and |
| | 87 | .IR TIFFCurrentTile , |
| | 88 | return the current row, strip, and tile, respectively, that is being read or |
| | 89 | written. These values are updated each time a read or write is done. |
| | 90 | .PP |
| | 91 | .IR TIFFFileno |
| | 92 | returns the underlying file descriptor used to access the |
| | 93 | .SM TIFF |
| | 94 | image in the filesystem. |
| | 95 | .PP |
| | 96 | .IR TIFFFileName |
| | 97 | returns the pathname argument passed to |
| | 98 | .IR TIFFOpen |
| | 99 | or |
| | 100 | .IR TIFFFdOpen . |
| | 101 | .PP |
| | 102 | .IR TIFFGetMode |
| | 103 | returns the mode with which the underlying file was opened. On |
| | 104 | .SM UNIX |
| | 105 | systems, this is the value passed to the |
| | 106 | .IR open (2) |
| | 107 | system call. |
| | 108 | .PP |
| | 109 | .IR TIFFIsTiled |
| | 110 | returns a non-zero value if the image data has a tiled organization. Zero is |
| | 111 | returned if the image data is organized in strips. |
| | 112 | .PP |
| | 113 | .IR TIFFIsByteSwapped |
| | 114 | returns a non-zero value if the image data was in a different byte-order than |
| | 115 | the host machine. Zero is returned if the TIFF file and local host byte-orders |
| | 116 | are the same. Note that TIFFReadTile(), TIFFReadStrip() and |
| | 117 | TIFFReadScanline() functions already normally perform byte swapping to local |
| | 118 | host order if needed. |
| | 119 | .PP |
| | 120 | .I TIFFIsUpSampled |
| | 121 | returns a non-zero value if image data returned through the read interface |
| | 122 | routines is being up-sampled. This can be useful to applications that want to |
| | 123 | calculate I/O buffer sizes to reflect this usage (though the usual strip and |
| | 124 | tile size routines already do this). |
| | 125 | .PP |
| | 126 | .I TIFFIsMSB2LSB |
| | 127 | returns a non-zero value if the image data is being returned with bit 0 as the |
| | 128 | most significant bit. |
| | 129 | .PP |
| | 130 | .IR TIFFGetVersion |
| | 131 | returns an |
| | 132 | .SM ASCII |
| | 133 | string that has a version stamp for the |
| | 134 | .SM TIFF |
| | 135 | library software. |
| | 136 | .SH DIAGNOSTICS |
| | 137 | None. |
| | 138 | .SH "SEE ALSO" |
| | 139 | .IR libtiff (3TIFF), |
| | 140 | .IR TIFFOpen (3TIFF), |
| | 141 | .IR TIFFFdOpen (3TIFF) |
projects / wxWidgets.git / blame_incremental