Blame html/man/TIFFReadScanline.3tiff.html

Packit 7838c8
Packit 7838c8
Packit 7838c8
<html>
Packit 7838c8
<head>
Packit 7838c8
<meta name="generator" content="groff -Thtml, see www.gnu.org">
Packit 7838c8
<meta name="Content-Style" content="text/css">
Packit 7838c8
<title>TIFFReadScanline</title>
Packit 7838c8
</head>
Packit 7838c8
<body>
Packit 7838c8
Packit 7838c8

TIFFReadScanline

Packit 7838c8
NAME
Packit 7838c8
SYNOPSIS
Packit 7838c8
DESCRIPTION
Packit 7838c8
NOTES
Packit 7838c8
RETURN VALUES
Packit 7838c8
DIAGNOSTICS
Packit 7838c8
BUGS
Packit 7838c8
SEE ALSO
Packit 7838c8
Packit 7838c8

Packit 7838c8
Packit 7838c8

NAME

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

TIFFReadScanline − read and decode a scanline of

Packit 7838c8
data from an open <small>TIFF</small> file

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

SYNOPSIS

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

#include <tiffio.h>

Packit 7838c8
Packit 7838c8

int TIFFReadScanline(TIFF *tif,

Packit 7838c8
tdata_t buf, uint32 row,
Packit 7838c8
tsample_t sample)

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

DESCRIPTION

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

Read the data for the specified row into the (user

Packit 7838c8
supplied) data buffer buf. The data are returned
Packit 7838c8
decompressed and, in the native byte- and bit-ordering, but
Packit 7838c8
are otherwise packed (see further below). The buffer must be
Packit 7838c8
large enough to hold an entire scanline of data.
Packit 7838c8
Applications should call the routine TIFFScanlineSize
Packit 7838c8
to find out the size (in bytes) of a scanline buffer. The
Packit 7838c8
row parameter is always used by
Packit 7838c8
TIFFReadScanline; the sample parameter is used
Packit 7838c8
only if data are organized in separate planes
Packit 7838c8
(PlanarConfiguration=2).

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

NOTES

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

The library attempts to hide bit- and byte-ordering

Packit 7838c8
differences between the image and the native machine by
Packit 7838c8
converting data to the native machine order. Bit reversal is
Packit 7838c8
done if the FillOrder tag is opposite to the native
Packit 7838c8
machine bit order. 16- and 32-bit samples are automatically
Packit 7838c8
byte-swapped if the file was written with a byte order
Packit 7838c8
opposite to the native machine byte order,

Packit 7838c8
Packit 7838c8

In C++ the sample parameter defaults to 0.

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

RETURN VALUES

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

TIFFReadScanline returns −1 if it detects an

Packit 7838c8
error; otherwise 1 is returned.

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

DIAGNOSTICS

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

All error messages are directed to the

Packit 7838c8
TIFFError(3TIFF) routine.

Packit 7838c8
Packit 7838c8

Compression algorithm does not support random

Packit 7838c8
access. Data was requested in a non-sequential order
Packit 7838c8
from a file that uses a compression algorithm and that has
Packit 7838c8
RowsPerStrip greater than one. That is, data in the
Packit 7838c8
image is stored in a compressed form, and with multiple rows
Packit 7838c8
packed into a strip. In this case, the library does not
Packit 7838c8
support random access to the data. The data should either be
Packit 7838c8
accessed sequentially, or the file should be converted so
Packit 7838c8
that each strip is made up of one row of data.

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

BUGS

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

Reading subsampled YCbCR data does not work correctly

Packit 7838c8
because, for PlanarConfiguration=2 the size of a
Packit 7838c8
scanline is not calculated on a per-sample basis, and for
Packit 7838c8
PlanarConfiguration=1 the library does not unpack the
Packit 7838c8
block-interleaved samples; use the strip- and tile-based
Packit 7838c8
interfaces to read these formats.

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

SEE ALSO

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

TIFFOpen(3TIFF),

Packit 7838c8
TIFFReadEncodedStrip(3TIFF),
Packit 7838c8
TIFFReadRawStrip(3TIFF), libtiff(3TIFF)

Packit 7838c8
Packit 7838c8

Libtiff library home page:

Packit 7838c8
http://www.simplesystems.org/libtiff/

Packit 7838c8
Packit 7838c8
Packit 7838c8

Packit 7838c8
</body>
Packit 7838c8
</html>