xref: /linux/Documentation/userspace-api/media/v4l/selections-common.rst (revision f77d26a9fc525286bcef3d4f98b52e17482cf49c)
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/userspace-api/media/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _v4l2-selections-common:
11
12Common selection definitions
13============================
14
15While the :ref:`V4L2 selection API <selection-api>` and
16:ref:`V4L2 subdev selection APIs <v4l2-subdev-selections>` are very
17similar, there's one fundamental difference between the two. On
18sub-device API, the selection rectangle refers to the media bus format,
19and is bound to a sub-device's pad. On the V4L2 interface the selection
20rectangles refer to the in-memory pixel format.
21
22This section defines the common definitions of the selection interfaces
23on the two APIs.
24
25
26.. toctree::
27    :maxdepth: 1
28
29    v4l2-selection-targets
30    v4l2-selection-flags
31