[PATCH v9 09/11] media: v4l2: document the usage of min/max for V4L2_CTRL_TYPE_RECT

Yunke Cao
2022-10-25T05:56:28Z

Document the default implementation of min/max for rectangle controls.

Signed-off-by: Yunke Cao <yunkec@google.com>
---
Changelog since v8:
- New patch.

Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst b/Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst
index 58982cd382e3..efa07428ba7a 100644
--- a/Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst
@@ -447,7 +447,11 @@ See also the examples in :ref:`control`.
- n/a
- A struct :c:type:`v4l2_rect`, containing a rectangle described by
the position of its top-left corner, the width and the height. Units
- depend on the use case.
+ depend on the use case. Use ``V4L2_CTRL_WHICH_MIN_VAL`` and
+ ``V4L2_CTRL_WHICH_MAX_VAL`` to query the range of rectangle sizes. The
+ top-left corner of the minimum and maximum rectangles should be the
+ same. For example, a control can have a minimum rectangle of 1x1@0x0 and
+ a maximum of 640x480@0x0.
* - ``V4L2_CTRL_TYPE_H264_SPS``
- n/a
- n/a
--
2.38.0.135.g90850a2211-goog