linux/Documentation/media/uapi/v4l/pixfmt.rst
Mauro Carvalho Chehab 60c2820d0f doc_rst: rename the media Sphinx suff to Documentation/media
The name of the subsystem is "media", and not "linux_tv". Also,
as we plan to add other stuff there in the future, let's
rename also the media uAPI book to media_uapi, to make it
clearer.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08 11:59:40 -03:00

36 lines
969 B
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _pixfmt:
#############
Image Formats
#############
The V4L2 API was primarily designed for devices exchanging image data
with applications. The :ref:`struct v4l2_pix_format <v4l2-pix-format>` and
:ref:`struct v4l2_pix_format_mplane <v4l2-pix-format-mplane>` structures define the
format and layout of an image in memory. The former is used with the
single-planar API, while the latter is used with the multi-planar
version (see :ref:`planar-apis`). Image formats are negotiated with
the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. (The explanations here
focus on video capturing and output, for overlay frame buffer formats
see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.)
.. toctree::
:maxdepth: 1
pixfmt-002
pixfmt-003
pixfmt-004
colorspaces
pixfmt-006
pixfmt-007
pixfmt-008
pixfmt-indexed
pixfmt-rgb
yuv-formats
depth-formats
pixfmt-013
sdr-formats
pixfmt-reserved