Documentation/media/uapi/v4l/v4l2-selection-targets.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-targets:
  11
  12 *****************
  13 Selection targets
  14 *****************
  15
  16 The precise meaning of the selection targets may be dependent on which
  17 of the two interfaces they are used.
  18
  19
  20 .. _v4l2-selection-targets-table:
  21
  22 .. tabularcolumns:: |p{6.0cm}|p{1.4cm}|p{7.4cm}|p{1.2cm}|p{1.4cm}|
  23
  24 .. flat-table:: Selection target definitions
  25     :header-rows:  1
  26     :stub-columns: 0
  27
  28     * - Target name
  29       - id
  30       - Definition
  31       - Valid for V4L2
  32       - Valid for V4L2 subdev
  33     * - ``V4L2_SEL_TGT_CROP``
  34       - 0x0000
  35       - Crop rectangle. Defines the cropped area.
  36       - Yes
  37       - Yes
  38     * - ``V4L2_SEL_TGT_CROP_DEFAULT``
  39       - 0x0001
  40       - Suggested cropping rectangle that covers the "whole picture".
  41       - Yes
  42       - No
  43     * - ``V4L2_SEL_TGT_CROP_BOUNDS``
  44       - 0x0002
  45       - Bounds of the crop rectangle. All valid crop rectangles fit inside
  46         the crop bounds rectangle.
  47       - Yes
  48       - Yes
  49     * - ``V4L2_SEL_TGT_NATIVE_SIZE``
  50       - 0x0003
  51       - The native size of the device, e.g. a sensor's pixel array.
  52         ``left`` and ``top`` fields are zero for this target.
  53       - Yes
  54       - Yes
  55     * - ``V4L2_SEL_TGT_COMPOSE``
  56       - 0x0100
  57       - Compose rectangle. Used to configure scaling and composition.
  58       - Yes
  59       - Yes
  60     * - ``V4L2_SEL_TGT_COMPOSE_DEFAULT``
  61       - 0x0101
  62       - Suggested composition rectangle that covers the "whole picture".
  63       - Yes
  64       - No
  65     * - ``V4L2_SEL_TGT_COMPOSE_BOUNDS``
  66       - 0x0102
  67       - Bounds of the compose rectangle. All valid compose rectangles fit
  68         inside the compose bounds rectangle.
  69       - Yes
  70       - Yes
  71     * - ``V4L2_SEL_TGT_COMPOSE_PADDED``
  72       - 0x0103
  73       - The active area and all padding pixels that are inserted or
  74         modified by hardware.
  75       - Yes
  76       - No