summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/v4l/v4l2-selection-targets.rst
blob: 7519099a50cd0f6abcd564654956fef1c5f10f52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
.. -*- coding: utf-8; mode: rst -*-

.. _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:

.. flat-table:: Selection target definitions
    :header-rows:  1
    :stub-columns: 0


    -  .. row 1

       -  Target name

       -  id

       -  Definition

       -  Valid for V4L2

       -  Valid for V4L2 subdev

    -  .. row 2

       -  ``V4L2_SEL_TGT_CROP``

       -  0x0000

       -  Crop rectangle. Defines the cropped area.

       -  Yes

       -  Yes

    -  .. row 3

       -  ``V4L2_SEL_TGT_CROP_DEFAULT``

       -  0x0001

       -  Suggested cropping rectangle that covers the "whole picture".

       -  Yes

       -  No

    -  .. row 4

       -  ``V4L2_SEL_TGT_CROP_BOUNDS``

       -  0x0002

       -  Bounds of the crop rectangle. All valid crop rectangles fit inside
	  the crop bounds rectangle.

       -  Yes

       -  Yes

    -  .. row 5

       -  ``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. Setting the
	  native size will generally only make sense for memory to memory
	  devices where the software can create a canvas of a given size in
	  which for example a video frame can be composed. In that case
	  V4L2_SEL_TGT_NATIVE_SIZE can be used to configure the size of
	  that canvas.

       -  Yes

       -  Yes

    -  .. row 6

       -  ``V4L2_SEL_TGT_COMPOSE``

       -  0x0100

       -  Compose rectangle. Used to configure scaling and composition.

       -  Yes

       -  Yes

    -  .. row 7

       -  ``V4L2_SEL_TGT_COMPOSE_DEFAULT``

       -  0x0101

       -  Suggested composition rectangle that covers the "whole picture".

       -  Yes

       -  No

    -  .. row 8

       -  ``V4L2_SEL_TGT_COMPOSE_BOUNDS``

       -  0x0102

       -  Bounds of the compose rectangle. All valid compose rectangles fit
	  inside the compose bounds rectangle.

       -  Yes

       -  Yes

    -  .. row 9

       -  ``V4L2_SEL_TGT_COMPOSE_PADDED``

       -  0x0103

       -  The active area and all padding pixels that are inserted or
	  modified by hardware.

       -  Yes

       -  No