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
  18     -  .. row 1
  19
  20        -  Flag name
  21
  22        -  id
  23
  24        -  Definition
  25
  26        -  Valid for V4L2
  27
  28        -  Valid for V4L2 subdev
  29
  30     -  .. row 2
  31
  32        -  ``V4L2_SEL_FLAG_GE``
  33
  34        -  (1 << 0)
  35
  36        -  Suggest the driver it should choose greater or equal rectangle (in
  37           size) than was requested. Albeit the driver may choose a lesser
  38           size, it will only do so due to hardware limitations. Without this
  39           flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
  40           closest possible rectangle.
  41
  42        -  Yes
  43
  44        -  Yes
  45
  46     -  .. row 3
  47
  48        -  ``V4L2_SEL_FLAG_LE``
  49
  50        -  (1 << 1)
  51
  52        -  Suggest the driver it should choose lesser or equal rectangle (in
  53           size) than was requested. Albeit the driver may choose a greater
  54           size, it will only do so due to hardware limitations.
  55
  56        -  Yes
  57
  58        -  Yes
  59
  60     -  .. row 4
  61
  62        -  ``V4L2_SEL_FLAG_KEEP_CONFIG``
  63
  64        -  (1 << 2)
  65
  66        -  The configuration must not be propagated to any further processing
  67           steps. If this flag is not given, the configuration is propagated
  68           inside the subdevice to all further processing steps.
  69
  70        -  No
  71
  72        -  Yes