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