doc-rst: linux_tv: Replace reference names to match ioctls
[linux-2.6-block.git] / Documentation / linux_tv / media / v4l / pixfmt.rst
CommitLineData
5377d91f
MH
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _pixfmt:
4
5#############
6Image Formats
7#############
8The V4L2 API was primarily designed for devices exchanging image data
9with applications. The :c:type:`struct v4l2_pix_format` and
10:c:type:`struct v4l2_pix_format_mplane` structures define the
11format and layout of an image in memory. The former is used with the
12single-planar API, while the latter is used with the multi-planar
13version (see :ref:`planar-apis`). Image formats are negotiated with
af4a4d0d 14the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. (The explanations here
5377d91f 15focus on video capturing and output, for overlay frame buffer formats
af4a4d0d 16see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.)
5377d91f
MH
17
18
19.. toctree::
20 :maxdepth: 1
21
22 pixfmt-002
23 pixfmt-003
24 pixfmt-004
25 colorspaces
26 pixfmt-006
27 pixfmt-007
28 pixfmt-008
29 pixfmt-indexed
30 pixfmt-rgb
31 yuv-formats
32 depth-formats
33 pixfmt-013
34 sdr-formats
35 pixfmt-reserved
36
37
38
39
40.. ------------------------------------------------------------------------------
41.. This file was automatically converted from DocBook-XML with the dbxml
42.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
43.. from the linux kernel, refer to:
44..
45.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
46.. ------------------------------------------------------------------------------