/src/3rdparty/libtiff/html/man/TIFFReadEncodedStrip.3tiff.html

https://bitbucket.org/ultra_iter/qt-vtl · HTML · 133 lines · 119 code · 2 blank · 12 comment · 0 complexity · 2dbcb007f0886562fde14cbf6e8253d2 MD5 · raw file 

    

  1. <!-- Creator     : groff version 1.18.1 -->
    2. 

  2. <!-- CreationDate: Fri Jul 13 17:43:16 2007 -->
    3. 

  3. <html>
    4. 

  4. <head>
    5. 

  5. <meta name="generator" content="groff -Thtml, see www.gnu.org">
    6. 

  6. <meta name="Content-Style" content="text/css">
    7. 

  7. <title>TIFFReadEncodedStrip</title>
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. 

  11. <h1 align=center>TIFFReadEncodedStrip</h1>
    12. 

  12. <a href="#NAME">NAME</a><br>
    13. 

  13. <a href="#SYNOPSIS">SYNOPSIS</a><br>
    14. 

  14. <a href="#DESCRIPTION">DESCRIPTION</a><br>
    15. 

  15. <a href="#NOTES">NOTES</a><br>
    16. 

  16. <a href="#RETURN VALUES">RETURN VALUES</a><br>
    17. 

  17. <a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
    18. 

  18. <a href="#SEE ALSO">SEE ALSO</a><br>
    19. 

  19. 

  20. <hr>
    21. 

  21. <a name="NAME"></a>
    22. 

  22. <h2>NAME</h2>
    23. 

  23. <!-- INDENTATION -->
    24. 

  24. <table width="100%" border=0 rules="none" frame="void"
    25. 

  25.        cols="2" cellspacing="0" cellpadding="0">
    26. 

  26. <tr valign="top" align="left">
    27. 

  27. <td width="8%"></td>
    28. 

  28. <td width="91%">
    29. 

  29. <p><big>TIFFReadEncodedStrip &minus; read and decode a strip
    30. 

  30. of data from an open</big> TIFF <big>file</big></p>
    31. 

  31. </td>
    32. 

  32. </table>
    33. 

  33. <a name="SYNOPSIS"></a>
    34. 

  34. <h2>SYNOPSIS</h2>
    35. 

  35. <!-- INDENTATION -->
    36. 

  36. <table width="100%" border=0 rules="none" frame="void"
    37. 

  37.        cols="2" cellspacing="0" cellpadding="0">
    38. 

  38. <tr valign="top" align="left">
    39. 

  39. <td width="8%"></td>
    40. 

  40. <td width="91%">
    41. 

  41. <p><big><b>#include &lt;tiffio.h&gt;</b></big></p>
    42. 

  42. <!-- INDENTATION -->
    43. 

  43. <p><big><b>tsize_t TIFFReadEncodedStrip(TIFF
    44. 

  44. *</b><i>tif</i><b>, tstrip_t</b> <i>strip</i><b>,
    45. 

  45. tdata_t</b> <i>buf</i><b>, tsize_t</b>
    46. 

  46. <i>size</i><b>)</b></big></p>
    47. 

  47. </td>
    48. 

  48. </table>
    49. 

  49. <a name="DESCRIPTION"></a>
    50. 

  50. <h2>DESCRIPTION</h2>
    51. 

  51. <!-- INDENTATION -->
    52. 

  52. <table width="100%" border=0 rules="none" frame="void"
    53. 

  53.        cols="2" cellspacing="0" cellpadding="0">
    54. 

  54. <tr valign="top" align="left">
    55. 

  55. <td width="8%"></td>
    56. 

  56. <td width="91%">
    57. 

  57. <p><big>Read the specified strip of data and place up to
    58. 

  58. <i>size</i> bytes of decompressed information in the (user
    59. 

  59. supplied) data buffer.</big></p>
    60. 

  60. </td>
    61. 

  61. </table>
    62. 

  62. <a name="NOTES"></a>
    63. 

  63. <h2>NOTES</h2>
    64. 

  64. <!-- INDENTATION -->
    65. 

  65. <table width="100%" border=0 rules="none" frame="void"
    66. 

  66.        cols="2" cellspacing="0" cellpadding="0">
    67. 

  67. <tr valign="top" align="left">
    68. 

  68. <td width="8%"></td>
    69. 

  69. <td width="91%">
    70. 

  70. <p><big>The value of <i>strip</i> is a &lsquo;&lsquo;raw
    71. 

  71. strip number.&rsquo;&rsquo; That is, the caller must take
    72. 

  72. into account whether or not the data are organized in
    73. 

  73. separate planes (<i>PlanarConfiguration</i>=2). To read a
    74. 

  74. full strip of data the data buffer should typically be at
    75. 

  75. least as large as the number returned by
    76. 

  76. <b>TIFFStripSize</b>(3TIFF). If the -1 passed in <i>size</i>
    77. 

  77. parameter, the whole strip will be read. You should be sure
    78. 

  78. you have enough space allocated for the buffer.</big></p>
    79. 

  79. <!-- INDENTATION -->
    80. 

  80. <p><big>The library attempts to hide bit- and byte-ordering
    81. 

  81. differences between the image and the native machine by
    82. 

  82. converting data to the native machine order. Bit reversal is
    83. 

  83. done if the <i>FillOrder</i> tag is opposite to the native
    84. 

  84. machine bit order. 16- and 32-bit samples are automatically
    85. 

  85. byte-swapped if the file was written with a byte order
    86. 

  86. opposite to the native machine byte order,</big></p>
    87. 

  87. </td>
    88. 

  88. </table>
    89. 

  89. <a name="RETURN VALUES"></a>
    90. 

  90. <h2>RETURN VALUES</h2>
    91. 

  91. <!-- INDENTATION -->
    92. 

  92. <table width="100%" border=0 rules="none" frame="void"
    93. 

  93.        cols="2" cellspacing="0" cellpadding="0">
    94. 

  94. <tr valign="top" align="left">
    95. 

  95. <td width="8%"></td>
    96. 

  96. <td width="91%">
    97. 

  97. <p><big>The actual number of bytes of data that were placed
    98. 

  98. in <i>buf</i> is returned; <i>TIFFReadEncodedStrip</i>
    99. 

  99. returns &minus;1 if an error was encountered.</big></p>
    100. 

  100. </td>
    101. 

  101. </table>
    102. 

  102. <a name="DIAGNOSTICS"></a>
    103. 

  103. <h2>DIAGNOSTICS</h2>
    104. 

  104. <!-- INDENTATION -->
    105. 

  105. <table width="100%" border=0 rules="none" frame="void"
    106. 

  106.        cols="2" cellspacing="0" cellpadding="0">
    107. 

  107. <tr valign="top" align="left">
    108. 

  108. <td width="8%"></td>
    109. 

  109. <td width="91%">
    110. 

  110. <p><big>All error messages are directed to the
    111. 

  111. <b>TIFFError</b>(3TIFF) routine.</big></p>
    112. 

  112. </td>
    113. 

  113. </table>
    114. 

  114. <a name="SEE ALSO"></a>
    115. 

  115. <h2>SEE ALSO</h2>
    116. 

  116. <!-- INDENTATION -->
    117. 

  117. <table width="100%" border=0 rules="none" frame="void"
    118. 

  118.        cols="2" cellspacing="0" cellpadding="0">
    119. 

  119. <tr valign="top" align="left">
    120. 

  120. <td width="8%"></td>
    121. 

  121. <td width="91%">
    122. 

  122. <p><big><b>TIFFOpen</b>(3TIFF),
    123. 

  123. <b>TIFFReadRawStrip</b>(3TIFF),
    124. 

  124. <b>TIFFReadScanline</b>(3TIFF),
    125. 

  125. <b>libtiff</b>(3TIFF)</big></p>
    126. 

  126. <!-- INDENTATION -->
    127. 

  127. <p><big>Libtiff library home page:
    128. 

  128. <b>http://www.remotesensing.org/libtiff/</b></big></p>
    129. 

  129. </td>
    130. 

  130. </table>
    131. 

  131. <hr>
    132. 

  132. </body>
    133. 

  133. </html>
    134.