Blame html/man/TIFFReadScanline.3tiff.html

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

TIFFReadScanline

Packit Service 2594b8
NAME
Packit Service 2594b8
SYNOPSIS
Packit Service 2594b8
DESCRIPTION
Packit Service 2594b8
NOTES
Packit Service 2594b8
RETURN VALUES
Packit Service 2594b8
DIAGNOSTICS
Packit Service 2594b8
BUGS
Packit Service 2594b8
SEE ALSO
Packit Service 2594b8
Packit Service 2594b8

Packit Service 2594b8
Packit Service 2594b8

NAME

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
       cols="2" cellspacing="0" cellpadding="0">
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

TIFFReadScanline − read and decode a scanline of

Packit Service 2594b8
data from an open <small>TIFF</small> file

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

SYNOPSIS

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
       cols="2" cellspacing="0" cellpadding="0">
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

#include <tiffio.h>

Packit Service 2594b8
Packit Service 2594b8

int TIFFReadScanline(TIFF *tif,

Packit Service 2594b8
tdata_t buf, uint32 row,
Packit Service 2594b8
tsample_t sample)

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

DESCRIPTION

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
       cols="2" cellspacing="0" cellpadding="0">
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

Read the data for the specified row into the (user

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

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

NOTES

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
       cols="2" cellspacing="0" cellpadding="0">
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

The library attempts to hide bit- and byte-ordering

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

Packit Service 2594b8
Packit Service 2594b8

In C++ the sample parameter defaults to 0.

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

RETURN VALUES

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
       cols="2" cellspacing="0" cellpadding="0">
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

TIFFReadScanline returns −1 if it detects an

Packit Service 2594b8
error; otherwise 1 is returned.

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

DIAGNOSTICS

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
       cols="2" cellspacing="0" cellpadding="0">
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

All error messages are directed to the

Packit Service 2594b8
TIFFError(3TIFF) routine.

Packit Service 2594b8
Packit Service 2594b8

Compression algorithm does not support random

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

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

BUGS

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
       cols="2" cellspacing="0" cellpadding="0">
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

Reading subsampled YCbCR data does not work correctly

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

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

SEE ALSO

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
       cols="2" cellspacing="0" cellpadding="0">
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

TIFFOpen(3TIFF),

Packit Service 2594b8
TIFFReadEncodedStrip(3TIFF),
Packit Service 2594b8
TIFFReadRawStrip(3TIFF), libtiff(3TIFF)

Packit Service 2594b8
Packit Service 2594b8

Libtiff library home page:

Packit Service 2594b8
http://www.simplesystems.org/libtiff/

Packit Service 2594b8
Packit Service 2594b8
Packit Service 2594b8

Packit Service 2594b8
</body>
Packit Service 2594b8
</html>