Documentation/media/uapi/v4l/v4l2-selection-flags.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _v4l2-selection-flags:
  11
  12 ***************
  13 Selection flags
  14 ***************
  15
  16 .. tabularcolumns:: |p{5.2cm}|p{2.0cm}|p{6.5cm}|p{1.2cm}|p{1.6cm}|
  17
  18 .. _v4l2-selection-flags-table:
  19
  20 .. flat-table:: Selection flag definitions
  21     :header-rows:  1
  22     :stub-columns: 0
  23
  24     * - Flag name
  25       - id
  26       - Definition
  27       - Valid for V4L2
  28       - Valid for V4L2 subdev
  29     * - ``V4L2_SEL_FLAG_GE``
  30       - (1 << 0)
  31       - Suggest the driver it should choose greater or equal rectangle (in
  32         size) than was requested. Albeit the driver may choose a lesser
  33         size, it will only do so due to hardware limitations. Without this
  34         flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
  35         closest possible rectangle.
  36       - Yes
  37       - Yes
  38     * - ``V4L2_SEL_FLAG_LE``
  39       - (1 << 1)
  40       - Suggest the driver it should choose lesser or equal rectangle (in
  41         size) than was requested. Albeit the driver may choose a greater
  42         size, it will only do so due to hardware limitations.
  43       - Yes
  44       - Yes
  45     * - ``V4L2_SEL_FLAG_KEEP_CONFIG``
  46       - (1 << 2)
  47       - The configuration must not be propagated to any further processing
  48         steps. If this flag is not given, the configuration is propagated
  49         inside the subdevice to all further processing steps.
  50       - No
  51       - Yes