xref: /linux/Documentation/userspace-api/media/v4l/v4l2-selection-flags.rst (revision 24bce201d79807b668bf9d9e0aca801c5c0d5f78)
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
3.. _v4l2-selection-flags:
4
5***************
6Selection flags
7***************
8
9.. _v4l2-selection-flags-table:
10
11.. raw:: latex
12
13   \small
14
15.. tabularcolumns:: |p{5.6cm}|p{2.0cm}|p{6.5cm}|p{1.2cm}|p{1.2cm}|
16
17.. cssclass:: longtable
18
19.. flat-table:: Selection flag definitions
20    :header-rows:  1
21    :stub-columns: 0
22
23    * - Flag name
24      - id
25      - Definition
26      - Valid for V4L2
27      - Valid for V4L2 subdev
28    * - ``V4L2_SEL_FLAG_GE``
29      - (1 << 0)
30      - Suggest the driver it should choose greater or equal rectangle (in
31	size) than was requested. Albeit the driver may choose a lesser
32	size, it will only do so due to hardware limitations. Without this
33	flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
34	closest possible rectangle.
35      - Yes
36      - Yes
37    * - ``V4L2_SEL_FLAG_LE``
38      - (1 << 1)
39      - Suggest the driver it should choose lesser or equal rectangle (in
40	size) than was requested. Albeit the driver may choose a greater
41	size, it will only do so due to hardware limitations.
42      - Yes
43      - Yes
44    * - ``V4L2_SEL_FLAG_KEEP_CONFIG``
45      - (1 << 2)
46      - The configuration must not be propagated to any further processing
47	steps. If this flag is not given, the configuration is propagated
48	inside the subdevice to all further processing steps.
49      - No
50      - Yes
51
52.. raw:: latex
53
54   \normalsize
55