Mirror/libcamera
1
0
Fork 0
mirror of https://git.libcamera.org/libcamera/libcamera.git synced 2025-07-16 08:55:06 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

libcamera: delayed_controls: Add missing documentation for ControlParams

Browse source 
Document struct DelayedControls::ControlParams and its associated
fields.

Signed-off-by: Naushir Patuck <naush@raspberrypi.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
This commit is contained in:
Naushir Patuck 2021-03-13 10:02:18 +00:00 • committed by Laurent Pinchart
parent 80bebfb64e
commit 1be6803924
1 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/libcamera/delayed_controls.cpp
View file

@ -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