From 1be68039247d986ea152cd3a171bc97e7e40866e Mon Sep 17 00:00:00 2001 From: Naushir Patuck Date: Sat, 13 Mar 2021 10:02:18 +0000 Subject: libcamera: delayed_controls: Add missing documentation for ControlParams Document struct DelayedControls::ControlParams and its associated fields. Signed-off-by: Naushir Patuck Reviewed-by: Laurent Pinchart Signed-off-by: Laurent Pinchart --- src/libcamera/delayed_controls.cpp | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'src/libcamera/delayed_controls.cpp') diff --git a/src/libcamera/delayed_controls.cpp b/src/libcamera/delayed_controls.cpp index a3917fd9..0bf81b51 100644 --- a/src/libcamera/delayed_controls.cpp +++ b/src/libcamera/delayed_controls.cpp @@ -37,6 +37,25 @@ LOG_DEFINE_CATEGORY(DelayedControls) * delay. */ +/** + * \struct DelayedControls::ControlParams + * \brief Parameters associated with controls handled by the \a DelayedControls + * helper class + * + * \var ControlParams::delay + * \brief Frame delay from setting the control on a sensor device to when it is + * consumed during framing. + * + * \var ControlParams::priorityWrite + * \brief Flag to indicate that this control must be applied ahead of, and + * separately from the other controls. + * + * Typically set for the \a V4L2_CID_VBLANK control so that the device driver + * does not reject \a V4L2_CID_EXPOSURE control values that may be outside of + * the existing vertical blanking specified bounds, but are within the new + * blanking bounds. + */ + /** * \brief Construct a DelayedControls instance * \param[in] device The V4L2 device the controls have to be applied to -- cgit v1.2.1