summaryrefslogtreecommitdiff
path: root/doc/functions/TIFFFieldDataType.rst
blob: 94b1df1fc1da6c62e5f66af471933d82cfbfd6df (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
TIFFFieldDataType
=================

Synopsis
--------

.. highlight:: c

::

    #include <tiffio.h>

.. c:enum:: TIFFDataType

    .. c:enumerator:: TIFF_NOTYPE

    placeholder

    .. c:enumerator:: TIFF_BYTE

    8-bit unsigned integer

    .. c:enumerator:: TIFF_ASCII

    8-bit bytes w/ last byte null

    .. c:enumerator:: TIFF_SHORT

    16-bit unsigned integer

    .. c:enumerator:: TIFF_LONG

    32-bit unsigned integer

    .. c:enumerator:: TIFF_RATIONAL

    64-bit unsigned fraction

    .. c:enumerator:: TIFF_SBYTE

    !8-bit signed integer

    .. c:enumerator:: TIFF_UNDEFINED

    !8-bit untyped data

    .. c:enumerator:: TIFF_SSHORT

    !16-bit signed integer

    .. c:enumerator:: TIFF_SLONG

    !32-bit signed integer

    .. c:enumerator:: TIFF_SRATIONAL

    !64-bit signed fraction

    .. c:enumerator:: TIFF_FLOAT

    !32-bit IEEE floating point

    .. c:enumerator:: TIFF_DOUBLE

    !64-bit IEEE floating point

    .. c:enumerator:: TIFF_IFD

    %32-bit unsigned integer (offset)

    .. c:enumerator:: TIFF_LONG8

    BigTIFF 64-bit unsigned integer

    .. c:enumerator:: TIFF_SLONG8

    BigTIFF 64-bit signed integer

    .. c:enumerator:: TIFF_IFD8

    BigTIFF 64-bit unsigned integer (offset)

.. c:macro:: TIFF_ANY

    An alias for :c:macro:`TIFF_NOTYPE`.

.. c:function:: TIFFDataType TIFFFieldDataType(const TIFFField* fip)

Description

:c:func:`TIFFFieldDataType` returns the data type stored in a TIFF field.
*fip* is a field information pointer previously returned by
:c:func:`TIFFFindField`, :c:func:`TIFFFieldWithTag`, or :c:func:`TIFFFieldWithName`.

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

:c:func:`TIFFFieldDataType` returns a member of the enum type
:c:type:`TIFFDataType`.

See also
--------

:doc:`libtiff` (3tiff)