staging: iio: Documentation fixes
[zen-stable.git] / Documentation / DocBook / v4l / pixfmt-y16.xml
blobd584040150784472191303f413bdcd9315e74d7c
1 <refentry id="V4L2-PIX-FMT-Y16">
2   <refmeta>
3     <refentrytitle>V4L2_PIX_FMT_Y16 ('Y16 ')</refentrytitle>
4     &manvol;
5   </refmeta>
6   <refnamediv>
7     <refname><constant>V4L2_PIX_FMT_Y16</constant></refname>
8     <refpurpose>Grey-scale image</refpurpose>
9   </refnamediv>
10   <refsect1>
11     <title>Description</title>
13     <para>This is a grey-scale image with a depth of 16 bits per
14 pixel. The least significant byte is stored at lower memory addresses
15 (little-endian). Note the actual sampling precision may be lower than
16 16 bits, for example 10 bits per pixel with values in range 0 to
17 1023.</para>
19     <example>
20       <title><constant>V4L2_PIX_FMT_Y16</constant> 4 &times; 4
21 pixel image</title>
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>Y'<subscript>00low</subscript></entry>
33                   <entry>Y'<subscript>00high</subscript></entry>
34                   <entry>Y'<subscript>01low</subscript></entry>
35                   <entry>Y'<subscript>01high</subscript></entry>
36                   <entry>Y'<subscript>02low</subscript></entry>
37                   <entry>Y'<subscript>02high</subscript></entry>
38                   <entry>Y'<subscript>03low</subscript></entry>
39                   <entry>Y'<subscript>03high</subscript></entry>
40                 </row>
41                 <row>
42                   <entry>start&nbsp;+&nbsp;8:</entry>
43                   <entry>Y'<subscript>10low</subscript></entry>
44                   <entry>Y'<subscript>10high</subscript></entry>
45                   <entry>Y'<subscript>11low</subscript></entry>
46                   <entry>Y'<subscript>11high</subscript></entry>
47                   <entry>Y'<subscript>12low</subscript></entry>
48                   <entry>Y'<subscript>12high</subscript></entry>
49                   <entry>Y'<subscript>13low</subscript></entry>
50                   <entry>Y'<subscript>13high</subscript></entry>
51                 </row>
52                 <row>
53                   <entry>start&nbsp;+&nbsp;16:</entry>
54                   <entry>Y'<subscript>20low</subscript></entry>
55                   <entry>Y'<subscript>20high</subscript></entry>
56                   <entry>Y'<subscript>21low</subscript></entry>
57                   <entry>Y'<subscript>21high</subscript></entry>
58                   <entry>Y'<subscript>22low</subscript></entry>
59                   <entry>Y'<subscript>22high</subscript></entry>
60                   <entry>Y'<subscript>23low</subscript></entry>
61                   <entry>Y'<subscript>23high</subscript></entry>
62                 </row>
63                 <row>
64                   <entry>start&nbsp;+&nbsp;24:</entry>
65                   <entry>Y'<subscript>30low</subscript></entry>
66                   <entry>Y'<subscript>30high</subscript></entry>
67                   <entry>Y'<subscript>31low</subscript></entry>
68                   <entry>Y'<subscript>31high</subscript></entry>
69                   <entry>Y'<subscript>32low</subscript></entry>
70                   <entry>Y'<subscript>32high</subscript></entry>
71                   <entry>Y'<subscript>33low</subscript></entry>
72                   <entry>Y'<subscript>33high</subscript></entry>
73                 </row>
74               </tbody>
75             </tgroup>
76           </informaltable>
77         </para>
78       </formalpara>
79     </example>
80   </refsect1>
81 </refentry>
83   <!--
84 Local Variables:
85 mode: sgml
86 sgml-parent-document: "pixfmt.sgml"
87 indent-tabs-mode: nil
88 End:
89   -->