src/3rdparty/libtiff/html/man/TIFFReadRawTile.3tiff.html
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 <!-- Creator     : groff version 1.18.1 -->
       
     2 <!-- CreationDate: Mon Mar 13 18:03:09 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>TIFFReadRawTile</title>
       
     8 </head>
       
     9 <body>
       
    10 
       
    11 <h1 align=center>TIFFReadRawTile</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="#RETURN VALUES">RETURN VALUES</a><br>
       
    16 <a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
       
    17 <a href="#SEE ALSO">SEE ALSO</a><br>
       
    18 
       
    19 <hr>
       
    20 <a name="NAME"></a>
       
    21 <h2>NAME</h2>
       
    22 <!-- INDENTATION -->
       
    23 <table width="100%" border=0 rules="none" frame="void"
       
    24        cols="2" cellspacing="0" cellpadding="0">
       
    25 <tr valign="top" align="left">
       
    26 <td width="8%"></td>
       
    27 <td width="91%">
       
    28 <p>TIFFReadRawTile &minus; return an undecoded tile of data
       
    29 from an open <small>TIFF</small> file</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 &lt;tiffio.h&gt;</b></p>
       
    41 <!-- INDENTATION -->
       
    42 <p><b>tsize_t TIFFReadRawTile(TIFF *</b><i>tif</i><b>,
       
    43 ttile_t</b> <i>tile</i><b>, tdata_t</b> <i>buf</i><b>,
       
    44 tsize_t</b> <i>size</i><b>)</b></p>
       
    45 </td>
       
    46 </table>
       
    47 <a name="DESCRIPTION"></a>
       
    48 <h2>DESCRIPTION</h2>
       
    49 <!-- INDENTATION -->
       
    50 <table width="100%" border=0 rules="none" frame="void"
       
    51        cols="2" cellspacing="0" cellpadding="0">
       
    52 <tr valign="top" align="left">
       
    53 <td width="8%"></td>
       
    54 <td width="91%">
       
    55 <p>Read the contents of the specified tile into the (user
       
    56 supplied) data buffer. Note that the value of <i>tile</i> is
       
    57 a &lsquo;&lsquo;raw tile number.&rsquo;&rsquo; That is, the
       
    58 caller must take into account whether or not the data is
       
    59 organized in separate planes (<i>PlanarConfiguration</i>=2).
       
    60 <i>TIFFComputeTile</i> automatically does this when
       
    61 converting an (x,y,z,sample) coordinate quadruple to a tile
       
    62 number. To read a full tile of data the data buffer should
       
    63 typically be at least as large as the value returned by
       
    64 <i>TIFFTileSize</i>.</p>
       
    65 </td>
       
    66 </table>
       
    67 <a name="RETURN VALUES"></a>
       
    68 <h2>RETURN VALUES</h2>
       
    69 <!-- INDENTATION -->
       
    70 <table width="100%" border=0 rules="none" frame="void"
       
    71        cols="2" cellspacing="0" cellpadding="0">
       
    72 <tr valign="top" align="left">
       
    73 <td width="8%"></td>
       
    74 <td width="91%">
       
    75 <p>The actual number of bytes of data that were placed in
       
    76 <i>buf</i> is returned; <i>TIFFReadEncodedTile</i> returns
       
    77 &minus;1 if an error was encountered.</p>
       
    78 </td>
       
    79 </table>
       
    80 <a name="DIAGNOSTICS"></a>
       
    81 <h2>DIAGNOSTICS</h2>
       
    82 <!-- INDENTATION -->
       
    83 <table width="100%" border=0 rules="none" frame="void"
       
    84        cols="2" cellspacing="0" cellpadding="0">
       
    85 <tr valign="top" align="left">
       
    86 <td width="8%"></td>
       
    87 <td width="91%">
       
    88 <p>All error messages are directed to the
       
    89 <b>TIFFError</b>(3TIFF) routine.</p>
       
    90 </td>
       
    91 </table>
       
    92 <a name="SEE ALSO"></a>
       
    93 <h2>SEE ALSO</h2>
       
    94 <!-- INDENTATION -->
       
    95 <table width="100%" border=0 rules="none" frame="void"
       
    96        cols="2" cellspacing="0" cellpadding="0">
       
    97 <tr valign="top" align="left">
       
    98 <td width="8%"></td>
       
    99 <td width="91%">
       
   100 <p><b>TIFFOpen</b>(3TIFF),
       
   101 <b>TIFFReadEncodedTile</b>(3TIFF),
       
   102 <b>TIFFReadTile</b>(3TIFF), <b>TIFFTileSize</b>(3TIFF),
       
   103 <b>libtiff</b>(3TIFF)</p>
       
   104 <!-- INDENTATION -->
       
   105 <p>Libtiff library home page:
       
   106 <b>http://www.remotesensing.org/libtiff/</b></p>
       
   107 </td>
       
   108 </table>
       
   109 <hr>
       
   110 </body>
       
   111 </html>