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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _v4l2-selection-flags:
   4
   5 ***************
   6 Selection flags
   7 ***************
   8
   9 .. tabularcolumns:: |p{5.2cm}|p{2.0cm}|p{6.5cm}|p{1.2cm}|p{1.6cm}|
  10
  11 .. _v4l2-selection-flags-table:
  12
  13 .. flat-table:: Selection flag definitions
  14     :header-rows:  1
  15     :stub-columns: 0
  16
  17     * - Flag name
  18       - id
  19       - Definition
  20       - Valid for V4L2
  21       - Valid for V4L2 subdev
  22     * - ``V4L2_SEL_FLAG_GE``
  23       - (1 << 0)
  24       - Suggest the driver it should choose greater or equal rectangle (in
  25         size) than was requested. Albeit the driver may choose a lesser
  26         size, it will only do so due to hardware limitations. Without this
  27         flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
  28         closest possible rectangle.
  29       - Yes
  30       - Yes
  31     * - ``V4L2_SEL_FLAG_LE``
  32       - (1 << 1)
  33       - Suggest the driver it should choose lesser or equal rectangle (in
  34         size) than was requested. Albeit the driver may choose a greater
  35         size, it will only do so due to hardware limitations.
  36       - Yes
  37       - Yes
  38     * - ``V4L2_SEL_FLAG_KEEP_CONFIG``
  39       - (1 << 2)
  40       - The configuration must not be propagated to any further processing
  41         steps. If this flag is not given, the configuration is propagated
  42         inside the subdevice to all further processing steps.
  43       - No
  44       - Yes