Documentation/userspace-api/media/v4l/v4l2-selection-targets.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2
   3 .. _v4l2-selection-targets:
   4
   5 *****************
   6 Selection targets
   7 *****************
   8
   9 The precise meaning of the selection targets may be dependent on which
  10 of the two interfaces they are used.
  11
  12
  13 .. _v4l2-selection-targets-table:
  14
  15 .. raw:: latex
  16
  17    \small
  18
  19 .. tabularcolumns:: |p{6.2cm}|p{1.4cm}|p{7.3cm}|p{1.2cm}|p{0.8cm}|
  20
  21 .. cssclass:: longtable
  22
  23 .. flat-table:: Selection target definitions
  24     :header-rows:  1
  25     :stub-columns: 0
  26
  27     * - Target name
  28       - id
  29       - Definition
  30       - Valid for V4L2
  31       - Valid for V4L2 subdev
  32     * - ``V4L2_SEL_TGT_CROP``
  33       - 0x0000
  34       - Crop rectangle. Defines the cropped area.
  35       - Yes
  36       - Yes
  37     * - ``V4L2_SEL_TGT_CROP_DEFAULT``
  38       - 0x0001
  39       - Suggested cropping rectangle that covers the "whole picture".
  40         This includes only active pixels and excludes other non-active
  41         pixels such as black pixels.
  42       - Yes
  43       - Yes
  44     * - ``V4L2_SEL_TGT_CROP_BOUNDS``
  45       - 0x0002
  46       - Bounds of the crop rectangle. All valid crop rectangles fit inside
  47         the crop bounds rectangle.
  48       - Yes
  49       - Yes
  50     * - ``V4L2_SEL_TGT_NATIVE_SIZE``
  51       - 0x0003
  52       - The native size of the device, e.g. a sensor's pixel array.
  53         ``left`` and ``top`` fields are zero for this target.
  54       - Yes
  55       - Yes
  56     * - ``V4L2_SEL_TGT_COMPOSE``
  57       - 0x0100
  58       - Compose rectangle. Used to configure scaling and composition.
  59       - Yes
  60       - Yes
  61     * - ``V4L2_SEL_TGT_COMPOSE_DEFAULT``
  62       - 0x0101
  63       - Suggested composition rectangle that covers the "whole picture".
  64       - Yes
  65       - No
  66     * - ``V4L2_SEL_TGT_COMPOSE_BOUNDS``
  67       - 0x0102
  68       - Bounds of the compose rectangle. All valid compose rectangles fit
  69         inside the compose bounds rectangle.
  70       - Yes
  71       - Yes
  72     * - ``V4L2_SEL_TGT_COMPOSE_PADDED``
  73       - 0x0103
  74       - The active area and all padding pixels that are inserted or
  75         modified by hardware.
  76       - Yes
  77       - No
  78
  79 .. raw:: latex
  80
  81    \normalsize