xref: /linux/Documentation/userspace-api/media/v4l/v4l2-selection-targets.rst (revision 778b8ebe5192e7a7f00563a7456517dfa63e1d90)
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. c:namespace:: V4L
3
4.. _v4l2-selection-targets:
5
6*****************
7Selection targets
8*****************
9
10The precise meaning of the selection targets may be dependent on which
11of the two interfaces they are used.
12
13
14.. _v4l2-selection-targets-table:
15
16.. raw:: latex
17
18   \small
19
20.. tabularcolumns:: |p{6.2cm}|p{1.4cm}|p{7.3cm}|p{1.2cm}|p{0.8cm}|
21
22.. cssclass:: longtable
23
24.. flat-table:: Selection target definitions
25    :header-rows:  1
26    :stub-columns: 0
27
28    * - Target name
29      - id
30      - Definition
31      - Valid for V4L2
32      - Valid for V4L2 subdev
33    * - ``V4L2_SEL_TGT_CROP``
34      - 0x0000
35      - Crop rectangle. Defines the cropped area.
36      - Yes
37      - Yes
38    * - ``V4L2_SEL_TGT_CROP_DEFAULT``
39      - 0x0001
40      - Suggested cropping rectangle that covers the "whole picture".
41        This includes only active pixels and excludes other non-active
42        pixels such as black pixels.
43      - Yes
44      - Yes
45    * - ``V4L2_SEL_TGT_CROP_BOUNDS``
46      - 0x0002
47      - Bounds of the crop rectangle. All valid crop rectangles fit inside
48	the crop bounds rectangle.
49      - Yes
50      - Yes
51    * - ``V4L2_SEL_TGT_NATIVE_SIZE``
52      - 0x0003
53      - The native size of the device, e.g. a sensor's pixel array.
54	``left`` and ``top`` fields are zero for this target.
55      - Yes
56      - Yes
57    * - ``V4L2_SEL_TGT_COMPOSE``
58      - 0x0100
59      - Compose rectangle. Used to configure scaling and composition.
60      - Yes
61      - Yes
62    * - ``V4L2_SEL_TGT_COMPOSE_DEFAULT``
63      - 0x0101
64      - Suggested composition rectangle that covers the "whole picture".
65      - Yes
66      - No
67    * - ``V4L2_SEL_TGT_COMPOSE_BOUNDS``
68      - 0x0102
69      - Bounds of the compose rectangle. All valid compose rectangles fit
70	inside the compose bounds rectangle.
71      - Yes
72      - Yes
73    * - ``V4L2_SEL_TGT_COMPOSE_PADDED``
74      - 0x0103
75      - The active area and all padding pixels that are inserted or
76	modified by hardware.
77      - Yes
78      - No
79
80.. raw:: latex
81
82   \normalsize
83