cheng/libtiff
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
bf02156034
libtiff/html/man/TIFFReadRGBATile.3t.html

268 lines
10 KiB
HTML
Raw Normal View History

Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta name="Content-Style" content="text/css">
<title>TIFFReadRGBATile</title>
</head>
<body>
<h1 align=center>TIFFReadRGBATile</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#NOTES">NOTES</a><br>
<a href="#RETURN VALUES">RETURN VALUES</a><br>
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
<a href="#BUGS">BUGS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
*** empty log message ***
2003-11-27 10:07:01 -05:00
<!-- Creator : groff version 1.17.2 -->
<!-- CreationDate: Thu Nov 27 17:58:03 2003 -->
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<a name="NAME"></a>
<h2>NAME</h2>
*** empty log message ***
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
*** empty log message ***
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
TIFFReadRGBATile - read and decode an image tile into a fixed-format raster</td></table>
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<table width="100%" border=0 rules="none" frame="void"
*** empty log message ***
2003-11-27 10:07:01 -05:00
cols="2" cellspacing="0" cellpadding="0">
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<tr valign="top" align="left">
*** empty log message ***
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
<pre><b>#include &lt;tiffio.h&gt;
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
*** empty log message ***
2003-11-27 10:07:01 -05:00
#define TIFFGetR(abgr) ((abgr) &amp; 0xff)
#define TIFFGetG(abgr) (((abgr) &gt;&gt; 8) &amp; 0xff)
#define TIFFGetB(abgr) (((abgr) &gt;&gt; 16) &amp; 0xff)
#define TIFFGetA(abgr) (((abgr) &gt;&gt; 24) &amp; 0xff)
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
*** empty log message ***
2003-11-27 10:07:01 -05:00
int TIFFReadRGBATile(TIFF* tif, uint32 x, uint32 y, uint32 * raster )
</b></pre></td></table>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
*** empty log message ***
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
<i>TIFFReadRGBATile</i> reads a single tile of a tile-based
image into memory, storing the result in the user supplied
RGBA <i>raster</i>. The raster is assumed to be an array of
width times length 32-bit entries, where width is the width
of a tile (TIFFTAG_TILEWIDTH) and length is the height of a
tile (TIFFTAG_TILELENGTH).</td></table>
<table width="100%" border=0 rules="none" frame="void"
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
*** empty log message ***
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
The <i>x</i> and <i>y</i> values are the offsets from the
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
top left corner to the top left corner of the tile to be
read. They must be an exact multiple of the tile width and
*** empty log message ***
2003-11-27 10:07:01 -05:00
length.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
Note that the raster is assume to be organized such that the
pixel at location (<i>x</i>,<i>y</i>) is
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<i>raster</i>[<i>y</i>*<i>width</i>+<i>x</i>]; with the
raster origin in the <i>lower-left hand corner</i> of the
tile. That is bottom to top organization. Edge tiles which
partly fall off the image will be filled out with
*** empty log message ***
2003-11-27 10:07:01 -05:00
appropriate zeroed areas.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
Raster pixels are 8-bit packed red, green, blue, alpha
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
samples. The macros <i>TIFFGetR</i>, <i>TIFFGetG</i>,
<i>TIFFGetB</i>, and <i>TIFFGetA</i> should be used to
access individual samples. Images without Associated Alpha
*** empty log message ***
2003-11-27 10:07:01 -05:00
matting information have a constant Alpha of 1.0
(255).</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
See the <i>TIFFRGBAImage</i>(3T) page for more details on
how various image types are converted to RGBA
values.</td></table>
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<a name="NOTES"></a>
<h2>NOTES</h2>
*** empty log message ***
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
Samples must be either 1, 2, 4, 8, or 16 bits. Colorimetric
samples/pixel must be either 1, 3, or 4 (i.e.
<i>SamplesPerPixel</i> minus
<i>ExtraSamples</i>).</td></table>
<table width="100%" border=0 rules="none" frame="void"
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
*** empty log message ***
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
Palette image colormaps that appear to be incorrectly
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
written as 8-bit values are automatically scaled to
*** empty log message ***
2003-11-27 10:07:01 -05:00
16-bits.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFReadRGBATile</i> is just a wrapper around the more
general <i>TIFFRGBAImage</i>(3T) facilities. It's main
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
advantage over the similar <i>TIFFReadRGBAImage()</i>
function is that for large images a single buffer capable of
*** empty log message ***
2003-11-27 10:07:01 -05:00
holding the whole image doesn't need to be allocated, only
enough for one tile. The <i>TIFFReadRGBAStrip()</i> function
does a similar operation for stripped images.</td></table>
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<a name="RETURN VALUES"></a>
<h2>RETURN VALUES</h2>
*** empty log message ***
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
*** empty log message ***
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
1 is returned if the image was successfully read and
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
converted. Otherwise, 0 is returned if an error was
*** empty log message ***
2003-11-27 10:07:01 -05:00
encountered.</td></table>
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<a name="DIAGNOSTICS"></a>
<h2>DIAGNOSTICS</h2>
*** empty log message ***
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
*** empty log message ***
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
All error messages are directed to the <i>TIFFError</i>(3T)
routine.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>Sorry, can not handle %d-bit pictures</b>. The image had
<i>BitsPerSample</i> other than 1, 2, 4, 8, or
16.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>Sorry, can not handle %d-channel images</b>. The image
had <i>SamplesPerPixel</i> other than 1, 3, or
4.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>Missing needed &quot;PhotometricInterpretation&quot;
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
tag</b>. The image did not have a tag that describes how to
*** empty log message ***
2003-11-27 10:07:01 -05:00
display the data.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>No &quot;PhotometricInterpretation&quot; tag, assuming
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
RGB</b>. The image was missing a tag that describes how to
display it, but because it has 3 or 4 samples/pixel, it is
*** empty log message ***
2003-11-27 10:07:01 -05:00
assumed to be <small>RGB.</small></td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>No &quot;PhotometricInterpretation&quot; tag, assuming
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
min-is-black</b>. The image was missing a tag that describes
how to display it, but because it has 1 sample/pixel, it is
*** empty log message ***
2003-11-27 10:07:01 -05:00
assumed to be a grayscale or bilevel image.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>No space for photometric conversion table</b>. There was
insufficient memory for a table used to convert image
samples to 8-bit <small>RGB.</small></td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>Missing required &quot;Colormap&quot; tag</b>. A Palette
image did not have a required <i>Colormap</i>
tag.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>No space for tile buffer</b>. There was insufficient
memory to allocate an i/o buffer.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>No space for strip buffer</b>. There was insufficient
memory to allocate an i/o buffer.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>Can not handle format</b>. The image has a format
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
(combination of <i>BitsPerSample</i>,
<i>SamplesPerPixel</i>, and
<i>PhotometricInterpretation</i>) that
*** empty log message ***
2003-11-27 10:07:01 -05:00
<i>TIFFReadRGBAImage</i> can not handle.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>No space for B&amp;W mapping table</b>. There was
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
insufficient memory to allocate a table used to map
*** empty log message ***
2003-11-27 10:07:01 -05:00
grayscale data to <small>RGB.</small></td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>No space for Palette mapping table</b>. There was
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
insufficient memory to allocate a table used to map data to
*** empty log message ***
2003-11-27 10:07:01 -05:00
8-bit <small>RGB.</small></td></table>
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<a name="BUGS"></a>
<h2>BUGS</h2>
*** empty log message ***
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
*** empty log message ***
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
Orientations other than bottom-left, or top-left are not
handled correctly.</td></table>
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
*** empty log message ***
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
*** empty log message ***
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
<i>libtiff</i>(3T), <i>TIFFOpen</i>(3T),
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<i>TIFFRGBAImage</i>(3T), <i>TIFFReadRGBAImage</i>(3T),
*** empty log message ***
2003-11-27 10:07:01 -05:00
<i>TIFFReadRGBAStrip</i>(3T)</td></table>
Updated from the actual manual pages.
2002-10-07 09:47:36 -04:00
<hr>
</body>
</html>
Reference in New Issue Copy Permalink