TIFFWriteEncodedTile (3)

Leading comments

$Id: TIFFWriteEncodedTile.3tiff,v 1.3 2016-09-25 20:05:50 bfriesen Exp $

Copyright (c) 1988-1997 Sam Leffler
Copyright (c) 1991-1997 Silicon Graphics, Inc.

Permission to use, copy, modify, distribute, and sell this software and
its documentation for any purpose is hereby granted without fee, provided
that (i) the above copyright notices and this permission notice appear in
all copies of the software and related documentation, and (ii) the names of
Sam Leffler and Silicon Graphics may not be...

(The comments found at the beginning of the groff file "man3/TIFFWriteEncodedTile.3tiff".)

NAME

TIFFWritedEncodedTile - compress and write a tile of data to an open file

SYNOPSIS

#include <tiffio.h>

tsize_t TIFFWriteEncodedTile(TIFF *tif, ttile_t tile, tdata_t buf, tsize_t size)

DESCRIPTION

Compress size bytes of raw data from buf and append the result to the end of the specified tile. Note that the value of tile is a ``raw tile number.'' That is, the caller must take into account whether or not the data are organized in separate places (PlanarConfiguration=2). TIFFComputeTile automatically does this when converting an (x,y,z,sample) coordinate quadruple to a tile number.

NOTES

The library writes encoded data using the native machine byte order. Correctly implemented readers are expected to do any necessary byte-swapping to correctly process image data with BitsPerSample greater than 8.

RETURN VALUES

-1 is returned if an error was encountered. Otherwise, the value of size is returned.

DIAGNOSTICS

All error messages are directed to the TIFFError(3TIFF) routine.

%s: File not open for writing. The file was opened for reading, not writing.

Can not write tiles to a stripped image. The image is assumed to be organized in strips because neither of the TileWidth or TileLength tags have been set with TIFFSetField(3TIFF).

%s: Must set "ImageWidth" before writing data. The image's width has not be set before the first write. See TIFFSetField(3TIFF) for information on how to do this.

%s: Must set "PlanarConfiguration" before writing data. The organization of data has not be defined before the first write. See TIFFSetField(3TIFF) for information on how to do this.

%s: No space for tile arrays". There was not enough space for the arrays that hold tile offsets and byte counts.

SEE ALSO

TIFFOpen(3TIFF), TIFFWriteTile(3TIFF), TIFFWriteRawTile(3TIFF), libtiff(3TIFF)

Libtiff library home page: www.simplesystems.org/libtiff