[mirror_ubuntu-artful-kernel.git] / Documentation / media / uapi / v4l / v4l2-selection-flags.rst

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

.. _v4l2-selection-flags:

***************
Selection flags
***************


.. _v4l2-selection-flags-table:

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


    -  .. row 1

       -  Flag name

       -  id

       -  Definition

       -  Valid for V4L2

       -  Valid for V4L2 subdev

    -  .. row 2

       -  ``V4L2_SEL_FLAG_GE``

       -  (1 << 0)

       -  Suggest the driver it should choose greater or equal rectangle (in
	  size) than was requested. Albeit the driver may choose a lesser
	  size, it will only do so due to hardware limitations. Without this
	  flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
	  closest possible rectangle.

       -  Yes

       -  Yes

    -  .. row 3

       -  ``V4L2_SEL_FLAG_LE``

       -  (1 << 1)

       -  Suggest the driver it should choose lesser or equal rectangle (in
	  size) than was requested. Albeit the driver may choose a greater
	  size, it will only do so due to hardware limitations.

       -  Yes

       -  Yes

    -  .. row 4

       -  ``V4L2_SEL_FLAG_KEEP_CONFIG``

       -  (1 << 2)

       -  The configuration must not be propagated to any further processing
	  steps. If this flag is not given, the configuration is propagated
	  inside the subdevice to all further processing steps.

       -  No

       -  Yes
Commit	Line	Data
5377d91f MH	1	.. -- coding: utf-8; mode: rst --
	2
	3	.. _v4l2-selection-flags:
	4
	5	***************
	6	Selection flags
	7	***************
	8
	9
	10	.. _v4l2-selection-flags-table:
	11
	12	.. flat-table:: Selection flag definitions
	13	:header-rows: 1
	14	:stub-columns: 0
	15
	16
	17	- .. row 1
	18
	19	- Flag name
	20
	21	- id
	22
	23	- Definition
	24
	25	- Valid for V4L2
	26
	27	- Valid for V4L2 subdev
	28
	29	- .. row 2
	30
	31	- ``V4L2_SEL_FLAG_GE``
	32
	33	- (1 << 0)
	34
	35	- Suggest the driver it should choose greater or equal rectangle (in
0579e6e3 MCC	36	size) than was requested. Albeit the driver may choose a lesser
	37	size, it will only do so due to hardware limitations. Without this
	38	flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
	39	closest possible rectangle.
5377d91f MH	40
	41	- Yes
	42
	43	- Yes
	44
	45	- .. row 3
	46
	47	- ``V4L2_SEL_FLAG_LE``
	48
	49	- (1 << 1)
	50
	51	- Suggest the driver it should choose lesser or equal rectangle (in
0579e6e3 MCC	52	size) than was requested. Albeit the driver may choose a greater
0579e6e3 MCC	53	size, it will only do so due to hardware limitations.
5377d91f MH	54
	55	- Yes
	56
	57	- Yes
	58
	59	- .. row 4
	60
	61	- ``V4L2_SEL_FLAG_KEEP_CONFIG``
	62
	63	- (1 << 2)
	64
	65	- The configuration must not be propagated to any further processing
0579e6e3 MCC	66	steps. If this flag is not given, the configuration is propagated
0579e6e3 MCC	67	inside the subdevice to all further processing steps.
5377d91f MH	68
	69	- No
	70
	71	- Yes