[media] vidioc-queryctrl.rst: document V4L2_CTRL_FLAG_MODIFY_LAYOUT

Document this new control flag.

Hans Verkuil committed 9 years ago

Commit bf587ef1 parent 0ac702d2 files · +14 −0Browse files

Unified · Split

2 files

@@ -507,6 +507,19 @@ See also the examples in :ref:`control`. · 506 unmodified lines
507	represents an action on the hardware. For example: clearing an	507	represents an action on the hardware. For example: clearing an
508	error flag or triggering the flash. All the controls of the type	508	error flag or triggering the flash. All the controls of the type
509	``V4L2_CTRL_TYPE_BUTTON`` have this flag set.	509	``V4L2_CTRL_TYPE_BUTTON`` have this flag set.
		510	* .. _FLAG_MODIFY_LAYOUT:
		511
		512	- ``V4L2_CTRL_FLAG_MODIFY_LAYOUT``
		513	- 0x0400
		514	- Changing this control value may modify the layout of the
		515	buffer (for video devices) or the media bus format (for sub-devices).
		516
		517	A typical example would be the ``V4L2_CID_ROTATE`` control.
		518
		519	Note that typically controls with this flag will also set the
		520	``V4L2_CTRL_FLAG_GRABBED`` flag when buffers are allocated or
		521	streaming is in progress since most drivers do not support changing
		522	the format in that case.
510		523
511		524
512	Return Value	525	Return Value

@@ -341,6 +341,7 @@ replace define V4L2_CTRL_FLAG_WRITE_ONLY control-flags · 340 unmodified lines
341	replace define V4L2_CTRL_FLAG_VOLATILE control-flags	341	replace define V4L2_CTRL_FLAG_VOLATILE control-flags
342	replace define V4L2_CTRL_FLAG_HAS_PAYLOAD control-flags	342	replace define V4L2_CTRL_FLAG_HAS_PAYLOAD control-flags
343	replace define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE control-flags	343	replace define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE control-flags
		344	replace define V4L2_CTRL_FLAG_MODIFY_LAYOUT control-flags
344		345
345	replace define V4L2_CTRL_FLAG_NEXT_CTRL control	346	replace define V4L2_CTRL_FLAG_NEXT_CTRL control
346	replace define V4L2_CTRL_FLAG_NEXT_COMPOUND control	347	replace define V4L2_CTRL_FLAG_NEXT_COMPOUND control