Documentation/media/uapi/v4l/pixfmt.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _pixfmt:
  11
  12 #############
  13 Image Formats
  14 #############
  15 The V4L2 API was primarily designed for devices exchanging image data
  16 with applications. The struct :c:type:`v4l2_pix_format` and
  17 struct :c:type:`v4l2_pix_format_mplane` structures define the
  18 format and layout of an image in memory. The former is used with the
  19 single-planar API, while the latter is used with the multi-planar
  20 version (see :ref:`planar-apis`). Image formats are negotiated with
  21 the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. (The explanations here
  22 focus on video capturing and output, for overlay frame buffer formats
  23 see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.)
  24
  25
  26 .. toctree::
  27     :maxdepth: 1
  28
  29     pixfmt-v4l2
  30     pixfmt-v4l2-mplane
  31     pixfmt-intro
  32     pixfmt-indexed
  33     pixfmt-rgb
  34     yuv-formats
  35     hsv-formats
  36     depth-formats
  37     pixfmt-compressed
  38     sdr-formats
  39     tch-formats
  40     meta-formats
  41     pixfmt-reserved
  42     colorspaces
  43     colorspaces-defs
  44     colorspaces-details