summaryrefslogtreecommitdiff
path: root/doc/functions/TIFFWriteRawStrip.rst
blob: 3b6c59bda9ea458632306adfeafbcfcd51492444 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
TIFFWriteRawStrip
=================

Synopsis
--------

.. highlight:: c

::

    #include <tiffio.h>

.. c:function:: tsize_t TIFFWriteRawStrip(TIFF* tif, tstrip_t strip, tdata_t buf, tsize_t size)

Description
-----------

Append *size* bytes of raw data to the specified strip.

Notes
-----

The strip number must be valid according to the current settings of the
``ImageLength`` and ``RowsPerStrip`` tags.
An image may be dynamically grown by increasing the value of
``ImageLength`` prior to each call to :c:func:`TIFFWriteRawStrip`.

Return values
-------------

-1 is returned if an error occurred.  Otherwise, the value of *size* is
returned.

Diagnostics
-----------

All error messages are directed to the :c:func:`TIFFError` routine.

``%s: File not open for writing``:

  The file was opened for reading, not writing.

``Can not write scanlines to a tiled image``:

  The image is assumed to be organized in tiles because the
  ``TileWidth`` and ``TileLength`` tags have been set with
  :c:func:`TIFFSetField`.

``%s: Must set "ImageWidth" before writing data``:

  The image's width has not be set before the first write.
  See :c:func:`TIFFSetField` 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 :c:func:`TIFFSetField` for information on how to do this.

``%s: No space for strip arrays"``:

  There was not enough space for the arrays that hold strip
  offsets and byte counts.

``%s: Strip %d out of range, max %d``:

  The specified strip is not a valid strip according to the
  currently specified image dimensions.

See also
--------

:doc:`TIFFOpen` (3tiff),
:doc:`TIFFWriteEncodedStrip` (3tiff),
:doc:`TIFFWriteScanline` (3tiff),
:doc:`libtiff` (3tiff)