Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[sfrench/cifs-2.6.git] / Documentation / DocBook / media / v4l / pixfmt-z16.xml
1 <refentry id="V4L2-PIX-FMT-Z16">
2   <refmeta>
3     <refentrytitle>V4L2_PIX_FMT_Z16 ('Z16 ')</refentrytitle>
4     &manvol;
5   </refmeta>
6   <refnamediv>
7     <refname><constant>V4L2_PIX_FMT_Z16</constant></refname>
8     <refpurpose>Interleaved grey-scale image, e.g. from a stereo-pair</refpurpose>
9   </refnamediv>
10   <refsect1>
11     <title>Description</title>
12
13     <para>This is a 16-bit format, representing depth data. Each pixel is a
14 distance to the respective point in the image coordinates. Distance unit can
15 vary and has to be negotiated with the device separately. Each pixel is stored
16 in a 16-bit word in the little endian byte order.
17 </para>
18
19     <example>
20       <title><constant>V4L2_PIX_FMT_Z16</constant> 4 &times; 4
21 pixel image</title>
22
23       <formalpara>
24         <title>Byte Order.</title>
25         <para>Each cell is one byte.
26           <informaltable frame="none">
27             <tgroup cols="9" align="center">
28               <colspec align="left" colwidth="2*" />
29               <tbody valign="top">
30                 <row>
31                   <entry>start&nbsp;+&nbsp;0:</entry>
32                   <entry>Z<subscript>00low</subscript></entry>
33                   <entry>Z<subscript>00high</subscript></entry>
34                   <entry>Z<subscript>01low</subscript></entry>
35                   <entry>Z<subscript>01high</subscript></entry>
36                   <entry>Z<subscript>02low</subscript></entry>
37                   <entry>Z<subscript>02high</subscript></entry>
38                   <entry>Z<subscript>03low</subscript></entry>
39                   <entry>Z<subscript>03high</subscript></entry>
40                 </row>
41                 <row>
42                   <entry>start&nbsp;+&nbsp;8:</entry>
43                   <entry>Z<subscript>10low</subscript></entry>
44                   <entry>Z<subscript>10high</subscript></entry>
45                   <entry>Z<subscript>11low</subscript></entry>
46                   <entry>Z<subscript>11high</subscript></entry>
47                   <entry>Z<subscript>12low</subscript></entry>
48                   <entry>Z<subscript>12high</subscript></entry>
49                   <entry>Z<subscript>13low</subscript></entry>
50                   <entry>Z<subscript>13high</subscript></entry>
51                 </row>
52                 <row>
53                   <entry>start&nbsp;+&nbsp;16:</entry>
54                   <entry>Z<subscript>20low</subscript></entry>
55                   <entry>Z<subscript>20high</subscript></entry>
56                   <entry>Z<subscript>21low</subscript></entry>
57                   <entry>Z<subscript>21high</subscript></entry>
58                   <entry>Z<subscript>22low</subscript></entry>
59                   <entry>Z<subscript>22high</subscript></entry>
60                   <entry>Z<subscript>23low</subscript></entry>
61                   <entry>Z<subscript>23high</subscript></entry>
62                 </row>
63                 <row>
64                   <entry>start&nbsp;+&nbsp;24:</entry>
65                   <entry>Z<subscript>30low</subscript></entry>
66                   <entry>Z<subscript>30high</subscript></entry>
67                   <entry>Z<subscript>31low</subscript></entry>
68                   <entry>Z<subscript>31high</subscript></entry>
69                   <entry>Z<subscript>32low</subscript></entry>
70                   <entry>Z<subscript>32high</subscript></entry>
71                   <entry>Z<subscript>33low</subscript></entry>
72                   <entry>Z<subscript>33high</subscript></entry>
73                 </row>
74               </tbody>
75             </tgroup>
76           </informaltable>
77         </para>
78       </formalpara>
79     </example>
80   </refsect1>
81 </refentry>