TIFFWriteScanline(3tiff) Introduction to Library Functions TIFFWriteScanline(3tiff)
NAME
TIFFWriteScanline - write a scanline to an open TIFF file
SYNOPSIS
#include <tiffio.h>
int TIFFWriteScanline(TIFF* tif, tdata_t buf, uint32 row,
tsample_t sample);
DESCRIPTION
Write data to a file at the specified row. The sample parameter is used only if data is organized in separate planes (PlanarConfigura-
tion=2). The data is assumed to be uncompressed and in the native bit- and byte-order of the host machine. The data written to the file is
compressed according to the compression scheme of the current TIFF directory as described below. If the current scanline is past the end
of the current subfile, the ImageLength field is automatically increased to include the scanline (except for PlanarConfiguration=2, where
the ImageLength cannot be changed once the first data is written). If the ImageLength is increased, the StripOffsets and StripByteCounts
fields are similarly enlarged to reflect data written past the previous end of image.
EXTENDED DESCRIPTION
The library writes encoded data using the native machine byte order. Correctly implemented TIFF readers are expected to do any necessary
byte-swapping to correctly process image data with BitsPerSample greater than 8. The library attempts to hide bit-ordering differences
between the image and the native machine by converting data from the native machine order.
Diagnostics
All error messages are directed to the TIFFError(3tiff) routine.
%s: File not open for wrThenfile was opened for reading, not writing.
Can not write scanlines An attempt wasgmade to write a scanline to a tiled image. The image is assumed to be organized in tiles because the
TileWidth and TileLength tags have been set with TIFFSetField(3tiff).
Compression algorithm doDataotwasppwrittendoinaacnon-sequential order to a file that uses a compression algorithm and that has RowsPerStrip
greater than one. That is, data in the image is to be stored in a compressed form, and with multiple rows packed
into a strip. In this case, the library does not support random access to the data. The data should either be writ-
ten as entire strips, sequentially by rows, or the value of RowsPerStrip should be set to one.
%s: Must set "ImageWidthTheeimagewwidthghastnot been set before the first write. See TIFFSetField(3tiff) for information on how to do this.
%s: Must set "PlanarConfTherorganizationeofrdataghastnot been defined before the first write. See TIFFSetField(3tiff) for information on
how to do this.
Can not change "ImageLenSeparaten image planestarelbeing used (PlanarConfiguration=2), but the number of rows has not been specified before
the first write. The library supports the dynamic growth of an image only when data is organized in a contiguous
manner (PlanarConfiguration=1).
%d: Sample out of range,Thexsample parameter was greater than the value of the SamplesPerPixel tag.
%s: No space for strip aThere"was not enough space for the arrays that hold strip offsets and byte counts.
RETURN VALUES
Returns --1 if it immediately detects an error, and 1 for a successful write.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
+-----------------------------+-----------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+-----------------------------+-----------------------------+
|Availability |SUNWTiff |
+-----------------------------+-----------------------------+
|Interface stability |External |
+-----------------------------+-----------------------------+
SEE ALSO
libtiff(3), TIFFOpen(3tiff), TIFFWriteEncodedStrip(3tiff), TIFFWriteRawStrip(3tiff)
NOTES
In C++, the sample parameter defaults to 0.
Once data is written to a file for the current directory, the values of certain tags may not be altered. See TIFFSetField(3tiff) for more
information.
It is not possible to write scanlines to a file that uses a tiled organization. The routine TIFFIsTiled can be used to determine if the
file is organized as tiles or strips.
Writing subsampled YCbCR data does not work correctly because:
o For PlanarConfiguration=2, the size of a scanline is not calculated on a per-sample basis.
o For PlanarConfiguration=1, the library does not unpack the block-interleaved samples.
This man page was originally written by Sam Leffler. Updated by Breda McColgan, Sun Microsystems Inc., 2004.
SunOS 5.10 05 Apr 2004 TIFFWriteScanline(3tiff)