0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002
0003 .. _v4l2-selection-targets:
0004
0005 *****************
0006 Selection targets
0007 *****************
0008
0009 The precise meaning of the selection targets may be dependent on which
0010 of the two interfaces they are used.
0011
0012
0013 .. _v4l2-selection-targets-table:
0014
0015 .. raw:: latex
0016
0017 \small
0018
0019 .. tabularcolumns:: |p{6.2cm}|p{1.4cm}|p{7.3cm}|p{1.2cm}|p{0.8cm}|
0020
0021 .. cssclass:: longtable
0022
0023 .. flat-table:: Selection target definitions
0024 :header-rows: 1
0025 :stub-columns: 0
0026
0027 * - Target name
0028 - id
0029 - Definition
0030 - Valid for V4L2
0031 - Valid for V4L2 subdev
0032 * - ``V4L2_SEL_TGT_CROP``
0033 - 0x0000
0034 - Crop rectangle. Defines the cropped area.
0035 - Yes
0036 - Yes
0037 * - ``V4L2_SEL_TGT_CROP_DEFAULT``
0038 - 0x0001
0039 - Suggested cropping rectangle that covers the "whole picture".
0040 This includes only active pixels and excludes other non-active
0041 pixels such as black pixels.
0042 - Yes
0043 - Yes
0044 * - ``V4L2_SEL_TGT_CROP_BOUNDS``
0045 - 0x0002
0046 - Bounds of the crop rectangle. All valid crop rectangles fit inside
0047 the crop bounds rectangle.
0048 - Yes
0049 - Yes
0050 * - ``V4L2_SEL_TGT_NATIVE_SIZE``
0051 - 0x0003
0052 - The native size of the device, e.g. a sensor's pixel array.
0053 ``left`` and ``top`` fields are zero for this target.
0054 - Yes
0055 - Yes
0056 * - ``V4L2_SEL_TGT_COMPOSE``
0057 - 0x0100
0058 - Compose rectangle. Used to configure scaling and composition.
0059 - Yes
0060 - Yes
0061 * - ``V4L2_SEL_TGT_COMPOSE_DEFAULT``
0062 - 0x0101
0063 - Suggested composition rectangle that covers the "whole picture".
0064 - Yes
0065 - No
0066 * - ``V4L2_SEL_TGT_COMPOSE_BOUNDS``
0067 - 0x0102
0068 - Bounds of the compose rectangle. All valid compose rectangles fit
0069 inside the compose bounds rectangle.
0070 - Yes
0071 - Yes
0072 * - ``V4L2_SEL_TGT_COMPOSE_PADDED``
0073 - 0x0103
0074 - The active area and all padding pixels that are inserted or
0075 modified by hardware.
0076 - Yes
0077 - No
0078
0079 .. raw:: latex
0080
0081 \normalsize
