linux/Documentation/userspace-api/media/v4l/v4l2-selection-targets.rst
Mauro Carvalho Chehab fea13a6935 media: docs: uAPI: fix table output in LaTeX/PDF format
There are lots of tables that are not properly displayed
in LaTeX/PDF.

Fix the tablecolumns, add longtable where needed and LaTeX
formatting macros, in order to address such issues.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2021-03-11 11:59:40 +01:00

82 lines
2.0 KiB
ReStructuredText

.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. _v4l2-selection-targets:
*****************
Selection targets
*****************
The precise meaning of the selection targets may be dependent on which
of the two interfaces they are used.
.. _v4l2-selection-targets-table:
.. raw:: latex
\small
.. tabularcolumns:: |p{6.2cm}|p{1.4cm}|p{7.3cm}|p{1.2cm}|p{0.8cm}|
.. cssclass:: longtable
.. flat-table:: Selection target definitions
:header-rows: 1
:stub-columns: 0
* - Target name
- id
- Definition
- Valid for V4L2
- Valid for V4L2 subdev
* - ``V4L2_SEL_TGT_CROP``
- 0x0000
- Crop rectangle. Defines the cropped area.
- Yes
- Yes
* - ``V4L2_SEL_TGT_CROP_DEFAULT``
- 0x0001
- Suggested cropping rectangle that covers the "whole picture".
This includes only active pixels and excludes other non-active
pixels such as black pixels.
- Yes
- Yes
* - ``V4L2_SEL_TGT_CROP_BOUNDS``
- 0x0002
- Bounds of the crop rectangle. All valid crop rectangles fit inside
the crop bounds rectangle.
- Yes
- Yes
* - ``V4L2_SEL_TGT_NATIVE_SIZE``
- 0x0003
- The native size of the device, e.g. a sensor's pixel array.
``left`` and ``top`` fields are zero for this target.
- Yes
- Yes
* - ``V4L2_SEL_TGT_COMPOSE``
- 0x0100
- Compose rectangle. Used to configure scaling and composition.
- Yes
- Yes
* - ``V4L2_SEL_TGT_COMPOSE_DEFAULT``
- 0x0101
- Suggested composition rectangle that covers the "whole picture".
- Yes
- No
* - ``V4L2_SEL_TGT_COMPOSE_BOUNDS``
- 0x0102
- Bounds of the compose rectangle. All valid compose rectangles fit
inside the compose bounds rectangle.
- Yes
- Yes
* - ``V4L2_SEL_TGT_COMPOSE_PADDED``
- 0x0103
- The active area and all padding pixels that are inserted or
modified by hardware.
- Yes
- No
.. raw:: latex
\normalsize