Documentation/linux_tv/media/v4l/v4l2-selection-targets.rst

.. -*- coding: utf-8; mode: rst -*-

.. _v4l2-selection-targets:

*****************
Selection targets
*****************

The precise meaning of the selection targets may be dependent on which
of the two interfaces they are used.


.. _v4l2-selection-targets-table:

.. flat-table:: Selection target definitions
    :header-rows:  1
    :stub-columns: 0


    -  .. row 1

       -  Target name

       -  id

       -  Definition

       -  Valid for V4L2

       -  Valid for V4L2 subdev

    -  .. row 2

       -  ``V4L2_SEL_TGT_CROP``

       -  0x0000

       -  Crop rectangle. Defines the cropped area.

       -  Yes

       -  Yes

    -  .. row 3

       -  ``V4L2_SEL_TGT_CROP_DEFAULT``

       -  0x0001

       -  Suggested cropping rectangle that covers the "whole picture".

       -  Yes

       -  No

    -  .. row 4

       -  ``V4L2_SEL_TGT_CROP_BOUNDS``

       -  0x0002

       -  Bounds of the crop rectangle. All valid crop rectangles fit inside
          the crop bounds rectangle.

       -  Yes

       -  Yes

    -  .. row 5

       -  ``V4L2_SEL_TGT_NATIVE_SIZE``

       -  0x0003

       -  The native size of the device, e.g. a sensor's pixel array.
          ``left`` and ``top`` fields are zero for this target. Setting the
          native size will generally only make sense for memory to memory
          devices where the software can create a canvas of a given size in
          which for example a video frame can be composed. In that case
          V4L2_SEL_TGT_NATIVE_SIZE can be used to configure the size of
          that canvas.

       -  Yes

       -  Yes

    -  .. row 6

       -  ``V4L2_SEL_TGT_COMPOSE``

       -  0x0100

       -  Compose rectangle. Used to configure scaling and composition.

       -  Yes

       -  Yes

    -  .. row 7

       -  ``V4L2_SEL_TGT_COMPOSE_DEFAULT``

       -  0x0101

       -  Suggested composition rectangle that covers the "whole picture".

       -  Yes

       -  No

    -  .. row 8

       -  ``V4L2_SEL_TGT_COMPOSE_BOUNDS``

       -  0x0102

       -  Bounds of the compose rectangle. All valid compose rectangles fit
          inside the compose bounds rectangle.

       -  Yes

       -  Yes

    -  .. row 9

       -  ``V4L2_SEL_TGT_COMPOSE_PADDED``

       -  0x0103

       -  The active area and all padding pixels that are inserted or
          modified by hardware.

       -  Yes

       -  No




.. ------------------------------------------------------------------------------
.. This file was automatically converted from DocBook-XML with the dbxml
.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
.. from the linux kernel, refer to:
..
.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
.. ------------------------------------------------------------------------------