]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - Documentation/media/uapi/v4l/pixfmt.rst
Merge branch 'x86-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[mirror_ubuntu-artful-kernel.git] / Documentation / media / uapi / 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
acf309a2
MCC
9with applications. The :ref:`struct v4l2_pix_format <v4l2-pix-format>` and
10:ref:`struct v4l2_pix_format_mplane <v4l2-pix-format-mplane>` structures define the
5377d91f
MH
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
4e03cb76 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