10dcb9ef1SAndrey Kiselev<!-- Creator     : groff version 1.18.1 -->
2f14d1a56SAndrey Kiselev<!-- CreationDate: Sat Feb 24 18:37:17 2007 -->
387c5da6fSAndrey Kiselev<html>
487c5da6fSAndrey Kiselev<head>
587c5da6fSAndrey Kiselev<meta name="generator" content="groff -Thtml, see www.gnu.org">
687c5da6fSAndrey Kiselev<meta name="Content-Style" content="text/css">
787c5da6fSAndrey Kiselev<title>TIFFReadRGBAStrip</title>
887c5da6fSAndrey Kiselev</head>
987c5da6fSAndrey Kiselev<body>
1087c5da6fSAndrey Kiselev
1187c5da6fSAndrey Kiselev<h1 align=center>TIFFReadRGBAStrip</h1>
1287c5da6fSAndrey Kiselev<a href="#NAME">NAME</a><br>
1387c5da6fSAndrey Kiselev<a href="#SYNOPSIS">SYNOPSIS</a><br>
1487c5da6fSAndrey Kiselev<a href="#DESCRIPTION">DESCRIPTION</a><br>
1587c5da6fSAndrey Kiselev<a href="#NOTES">NOTES</a><br>
1687c5da6fSAndrey Kiselev<a href="#RETURN VALUES">RETURN VALUES</a><br>
1787c5da6fSAndrey Kiselev<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
1887c5da6fSAndrey Kiselev<a href="#SEE ALSO">SEE ALSO</a><br>
1987c5da6fSAndrey Kiselev
2087c5da6fSAndrey Kiselev<hr>
2187c5da6fSAndrey Kiselev<a name="NAME"></a>
2287c5da6fSAndrey Kiselev<h2>NAME</h2>
230dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
240dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
250dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
260dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
270dcb9ef1SAndrey Kiselev<td width="8%"></td>
280dcb9ef1SAndrey Kiselev<td width="91%">
290dcb9ef1SAndrey Kiselev<p>TIFFReadRGBAStrip &minus; read and decode an image strip
300dcb9ef1SAndrey Kiselevinto a fixed-format raster</p>
310dcb9ef1SAndrey Kiselev</td>
320dcb9ef1SAndrey Kiselev</table>
3387c5da6fSAndrey Kiselev<a name="SYNOPSIS"></a>
3487c5da6fSAndrey Kiselev<h2>SYNOPSIS</h2>
350dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
360dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
370dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
380dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
390dcb9ef1SAndrey Kiselev<td width="8%"></td>
400dcb9ef1SAndrey Kiselev<td width="91%">
410dcb9ef1SAndrey Kiselev<p><b>#include &lt;tiffio.h&gt;</b></p>
420dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
430dcb9ef1SAndrey Kiselev<p><b>#define TIFFGetR(abgr) ((abgr) &amp; 0xff)<br>
4405fb5662SAndrey Kiselev#define TIFFGetG(abgr) (((abgr) &gt;&gt; 8) &amp; 0xff)<br>
450dcb9ef1SAndrey Kiselev#define TIFFGetB(abgr) (((abgr) &gt;&gt; 16) &amp; 0xff)<br>
4605fb5662SAndrey Kiselev#define TIFFGetA(abgr) (((abgr) &gt;&gt; 24) &amp;
4705fb5662SAndrey Kiselev0xff)</b></p>
480dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
490dcb9ef1SAndrey Kiselev<p><b>int TIFFReadRGBAStrip(TIFF *</b><i>tif</i><b>,
500dcb9ef1SAndrey Kiselevuint32</b> <i>row</i><b>, uint32
510dcb9ef1SAndrey Kiselev*</b><i>raster</i><b>)</b></p>
520dcb9ef1SAndrey Kiselev</td>
530dcb9ef1SAndrey Kiselev</table>
5487c5da6fSAndrey Kiselev<a name="DESCRIPTION"></a>
5587c5da6fSAndrey Kiselev<h2>DESCRIPTION</h2>
560dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
570dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
580dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
590dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
600dcb9ef1SAndrey Kiselev<td width="8%"></td>
610dcb9ef1SAndrey Kiselev<td width="91%">
620dcb9ef1SAndrey Kiselev<p><i>TIFFReadRGBAStrip</i> reads a single strip of a
630dcb9ef1SAndrey Kiselevstrip-based image into memory, storing the result in the
640dcb9ef1SAndrey Kiselevuser supplied RGBA <i>raster</i>. The raster is assumed to
650dcb9ef1SAndrey Kiselevbe an array of width times rowsperstrip 32-bit entries,
660dcb9ef1SAndrey Kiselevwhere width is the width of the image (TIFFTAG_IMAGEWIDTH)
670dcb9ef1SAndrey Kiselevand rowsperstrip is the maximum lines in a strip
680dcb9ef1SAndrey Kiselev(TIFFTAG_ROWSPERSTRIP).</p>
690dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
700dcb9ef1SAndrey Kiselev<p>The <i>row</i> value should be the row of the first row
710dcb9ef1SAndrey Kiselevin the strip (strip * rowsperstrip, zero based).</p>
720dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
730dcb9ef1SAndrey Kiselev<p>Note that the raster is assume to be organized such that
740dcb9ef1SAndrey Kiselevthe pixel at location (<i>x</i>,<i>y</i>) is
7587c5da6fSAndrey Kiselev<i>raster</i>[<i>y</i>*<i>width</i>+<i>x</i>]; with the
7687c5da6fSAndrey Kiselevraster origin in the <i>lower-left hand corner</i> of the
7787c5da6fSAndrey Kiselevstrip. That is bottom to top organization. When reading a
7887c5da6fSAndrey Kiselevpartial last strip in the file the last line of the image
7987c5da6fSAndrey Kiselevwill begin at the beginning of the buffer.</p>
800dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
810dcb9ef1SAndrey Kiselev<p>Raster pixels are 8-bit packed red, green, blue, alpha
820dcb9ef1SAndrey Kiselevsamples. The macros <i>TIFFGetR</i>, <i>TIFFGetG</i>,
830dcb9ef1SAndrey Kiselev<i>TIFFGetB</i>, and <i>TIFFGetA</i> should be used to
840dcb9ef1SAndrey Kiselevaccess individual samples. Images without Associated Alpha
850dcb9ef1SAndrey Kiselevmatting information have a constant Alpha of 1.0 (255).</p>
860dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
870dcb9ef1SAndrey Kiselev<p>See the <i>TIFFRGBAImage</i>(3TIFF) page for more details
880dcb9ef1SAndrey Kiselevon how various image types are converted to RGBA values.</p>
890dcb9ef1SAndrey Kiselev</td>
900dcb9ef1SAndrey Kiselev</table>
9187c5da6fSAndrey Kiselev<a name="NOTES"></a>
9287c5da6fSAndrey Kiselev<h2>NOTES</h2>
930dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
940dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
950dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
960dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
970dcb9ef1SAndrey Kiselev<td width="8%"></td>
980dcb9ef1SAndrey Kiselev<td width="91%">
990dcb9ef1SAndrey Kiselev<p>Samples must be either 1, 2, 4, 8, or 16 bits.
1000dcb9ef1SAndrey KiselevColorimetric samples/pixel must be either 1, 3, or 4 (i.e.
1010dcb9ef1SAndrey Kiselev<i>SamplesPerPixel</i> minus <i>ExtraSamples</i>).</p>
1020dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1030dcb9ef1SAndrey Kiselev<p>Palette image colormaps that appear to be incorrectly
1040dcb9ef1SAndrey Kiselevwritten as 8-bit values are automatically scaled to
1050dcb9ef1SAndrey Kiselev16-bits.</p>
1060dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1070dcb9ef1SAndrey Kiselev<p><i>TIFFReadRGBAStrip</i> is just a wrapper around the
1080dcb9ef1SAndrey Kiselevmore general <i>TIFFRGBAImage</i>(3TIFF) facilities.
1090dcb9ef1SAndrey KiselevIt&rsquo;s main advantage over the similar
1100dcb9ef1SAndrey Kiselev<i>TIFFReadRGBAImage()</i> function is that for large images
1110dcb9ef1SAndrey Kiseleva single buffer capable of holding the whole image
1120dcb9ef1SAndrey Kiselevdoesn&rsquo;t need to be allocated, only enough for one
1130dcb9ef1SAndrey Kiselevstrip. The <i>TIFFReadRGBATile()</i> function does a similar
1140dcb9ef1SAndrey Kiselevoperation for tiled images.</p>
1150dcb9ef1SAndrey Kiselev</td>
1160dcb9ef1SAndrey Kiselev</table>
11787c5da6fSAndrey Kiselev<a name="RETURN VALUES"></a>
11887c5da6fSAndrey Kiselev<h2>RETURN VALUES</h2>
1190dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1200dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
1210dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
1220dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
1230dcb9ef1SAndrey Kiselev<td width="8%"></td>
1240dcb9ef1SAndrey Kiselev<td width="91%">
1250dcb9ef1SAndrey Kiselev<p>1 is returned if the image was successfully read and
1260dcb9ef1SAndrey Kiselevconverted. Otherwise, 0 is returned if an error was
1270dcb9ef1SAndrey Kiselevencountered.</p>
1280dcb9ef1SAndrey Kiselev</td>
1290dcb9ef1SAndrey Kiselev</table>
13087c5da6fSAndrey Kiselev<a name="DIAGNOSTICS"></a>
13187c5da6fSAndrey Kiselev<h2>DIAGNOSTICS</h2>
1320dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1330dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
1340dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
1350dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
1360dcb9ef1SAndrey Kiselev<td width="8%"></td>
1370dcb9ef1SAndrey Kiselev<td width="91%">
1380dcb9ef1SAndrey Kiselev<p>All error messages are directed to the
1390dcb9ef1SAndrey Kiselev<i>TIFFError</i>(3TIFF) routine.</p>
1400dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1410dcb9ef1SAndrey Kiselev<p><b>Sorry, can not handle %d-bit pictures</b>. The image
1420dcb9ef1SAndrey Kiselevhad <i>BitsPerSample</i> other than 1, 2, 4, 8, or 16.</p>
1430dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1440dcb9ef1SAndrey Kiselev<p><b>Sorry, can not handle %d-channel images</b>. The image
1450dcb9ef1SAndrey Kiselevhad <i>SamplesPerPixel</i> other than 1, 3, or 4.</p>
1460dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1470dcb9ef1SAndrey Kiselev<p><b>Missing needed &quot;PhotometricInterpretation&quot;
1480dcb9ef1SAndrey Kiselevtag</b>. The image did not have a tag that describes how to
1490dcb9ef1SAndrey Kiselevdisplay the data.</p>
1500dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1510dcb9ef1SAndrey Kiselev<p><b>No &quot;PhotometricInterpretation&quot; tag, assuming
1520dcb9ef1SAndrey KiselevRGB</b>. The image was missing a tag that describes how to
1530dcb9ef1SAndrey Kiselevdisplay it, but because it has 3 or 4 samples/pixel, it is
1540dcb9ef1SAndrey Kiselevassumed to be <small>RGB.</small></p>
1550dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1560dcb9ef1SAndrey Kiselev<p><b>No &quot;PhotometricInterpretation&quot; tag, assuming
15787c5da6fSAndrey Kiselevmin-is-black</b>. The image was missing a tag that describes
15887c5da6fSAndrey Kiselevhow to display it, but because it has 1 sample/pixel, it is
15987c5da6fSAndrey Kiselevassumed to be a grayscale or bilevel image.</p>
1600dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1610dcb9ef1SAndrey Kiselev<p><b>No space for photometric conversion table</b>. There
1620dcb9ef1SAndrey Kiselevwas insufficient memory for a table used to convert image
1630dcb9ef1SAndrey Kiselevsamples to 8-bit <small>RGB.</small></p>
1640dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1650dcb9ef1SAndrey Kiselev<p><b>Missing required &quot;Colormap&quot; tag</b>. A
1660dcb9ef1SAndrey KiselevPalette image did not have a required <i>Colormap</i>
1670dcb9ef1SAndrey Kiselevtag.</p>
1680dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1690dcb9ef1SAndrey Kiselev<p><b>No space for tile buffer</b>. There was insufficient
1700dcb9ef1SAndrey Kiselevmemory to allocate an i/o buffer.</p>
1710dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1720dcb9ef1SAndrey Kiselev<p><b>No space for strip buffer</b>. There was insufficient
1730dcb9ef1SAndrey Kiselevmemory to allocate an i/o buffer.</p>
1740dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1750dcb9ef1SAndrey Kiselev<p><b>Can not handle format</b>. The image has a format
1760dcb9ef1SAndrey Kiselev(combination of <i>BitsPerSample</i>,
1770dcb9ef1SAndrey Kiselev<i>SamplesPerPixel</i>, and
17887c5da6fSAndrey Kiselev<i>PhotometricInterpretation</i>) that
17987c5da6fSAndrey Kiselev<i>TIFFReadRGBAImage</i> can not handle.</p>
1800dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1810dcb9ef1SAndrey Kiselev<p><b>No space for B&amp;W mapping table</b>. There was
1820dcb9ef1SAndrey Kiselevinsufficient memory to allocate a table used to map
1830dcb9ef1SAndrey Kiselevgrayscale data to <small>RGB.</small></p>
1840dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1850dcb9ef1SAndrey Kiselev<p><b>No space for Palette mapping table</b>. There was
1860dcb9ef1SAndrey Kiselevinsufficient memory to allocate a table used to map data to
1870dcb9ef1SAndrey Kiselev8-bit <small>RGB.</small></p>
1880dcb9ef1SAndrey Kiselev</td>
1890dcb9ef1SAndrey Kiselev</table>
19087c5da6fSAndrey Kiselev<a name="SEE ALSO"></a>
19187c5da6fSAndrey Kiselev<h2>SEE ALSO</h2>
1920dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1930dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
1940dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
1950dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
1960dcb9ef1SAndrey Kiselev<td width="8%"></td>
1970dcb9ef1SAndrey Kiselev<td width="91%">
1980dcb9ef1SAndrey Kiselev<p><b>TIFFOpen</b>(3TIFF), <b>TIFFRGBAImage</b>(3TIFF),
1990776b32dSAndrey Kiselev<b>TIFFReadRGBAImage</b>(3TIFF),
2000776b32dSAndrey Kiselev<b>TIFFReadRGBATile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
2010dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
2020dcb9ef1SAndrey Kiselev<p>Libtiff library home page:
203*d4dd6cccSBob Friesenhahn<b>http://www.simplesystems.org/libtiff/</b></p>
2040dcb9ef1SAndrey Kiselev</td>
2050dcb9ef1SAndrey Kiselev</table>
20687c5da6fSAndrey Kiselev<hr>
20787c5da6fSAndrey Kiselev</body>
20887c5da6fSAndrey Kiselev</html>
209