Merge remote-tracking branch 'block/for-next'
[deliverable/linux.git] / Documentation / media / uapi / v4l / v4l2-selection-targets.rst
CommitLineData
5377d91f
MH
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _v4l2-selection-targets:
4
5*****************
6Selection targets
7*****************
8
9The precise meaning of the selection targets may be dependent on which
10of the two interfaces they are used.
11
12
13.. _v4l2-selection-targets-table:
14
ed5d28d0
MCC
15.. tabularcolumns:: |p{5.8cm}|p{1.4cm}|p{6.5cm}|p{1.2cm}|p{1.6cm}|
16
5377d91f
MH
17.. flat-table:: Selection target definitions
18 :header-rows: 1
19 :stub-columns: 0
20
21
22 - .. row 1
23
24 - Target name
25
26 - id
27
28 - Definition
29
30 - Valid for V4L2
31
32 - Valid for V4L2 subdev
33
34 - .. row 2
35
36 - ``V4L2_SEL_TGT_CROP``
37
38 - 0x0000
39
40 - Crop rectangle. Defines the cropped area.
41
42 - Yes
43
44 - Yes
45
46 - .. row 3
47
48 - ``V4L2_SEL_TGT_CROP_DEFAULT``
49
50 - 0x0001
51
52 - Suggested cropping rectangle that covers the "whole picture".
53
54 - Yes
55
56 - No
57
58 - .. row 4
59
60 - ``V4L2_SEL_TGT_CROP_BOUNDS``
61
62 - 0x0002
63
64 - Bounds of the crop rectangle. All valid crop rectangles fit inside
0579e6e3 65 the crop bounds rectangle.
5377d91f
MH
66
67 - Yes
68
69 - Yes
70
71 - .. row 5
72
73 - ``V4L2_SEL_TGT_NATIVE_SIZE``
74
75 - 0x0003
76
77 - The native size of the device, e.g. a sensor's pixel array.
0579e6e3
MCC
78 ``left`` and ``top`` fields are zero for this target. Setting the
79 native size will generally only make sense for memory to memory
80 devices where the software can create a canvas of a given size in
81 which for example a video frame can be composed. In that case
82 V4L2_SEL_TGT_NATIVE_SIZE can be used to configure the size of
83 that canvas.
5377d91f
MH
84
85 - Yes
86
87 - Yes
88
89 - .. row 6
90
91 - ``V4L2_SEL_TGT_COMPOSE``
92
93 - 0x0100
94
95 - Compose rectangle. Used to configure scaling and composition.
96
97 - Yes
98
99 - Yes
100
101 - .. row 7
102
103 - ``V4L2_SEL_TGT_COMPOSE_DEFAULT``
104
105 - 0x0101
106
107 - Suggested composition rectangle that covers the "whole picture".
108
109 - Yes
110
111 - No
112
113 - .. row 8
114
115 - ``V4L2_SEL_TGT_COMPOSE_BOUNDS``
116
117 - 0x0102
118
119 - Bounds of the compose rectangle. All valid compose rectangles fit
0579e6e3 120 inside the compose bounds rectangle.
5377d91f
MH
121
122 - Yes
123
124 - Yes
125
126 - .. row 9
127
128 - ``V4L2_SEL_TGT_COMPOSE_PADDED``
129
130 - 0x0103
131
132 - The active area and all padding pixels that are inserted or
0579e6e3 133 modified by hardware.
5377d91f
MH
134
135 - Yes
136
137 - No
This page took 0.052965 seconds and 5 git commands to generate.