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

libcamera: CameraSensor: Mention V4L2 in get/setControls()

Browse source 
The current CameraSensor interface for reading and writing controls
is currently based on V4L2 controls.

Mention that more clearly in the documentation and, while at it, re-sort
the documentation to match the methods declaration order.

Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
This commit is contained in:
Jacopo Mondi 2021-01-02 10:20:01 +01:00
parent 992442df9a
commit db19dcb75d
1 changed files with 13 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

24
src/libcamera/camera_sensor.cpp
View file

@ -590,11 +590,12 @@ const ControlInfoMap &CameraSensor::controls() const
} }
/** /**
* \brief Read controls from the sensor * \brief Read V4L2 controls from the sensor
* \param[in] ids The list of controls to read, specified by their ID * \param[in] ids The list of controls to read, specified by their ID
* *
* This method reads the value of all controls contained in \a ids, and returns * This method reads the value of all controls contained in \a ids, and returns
* their values as a ControlList. * their values as a ControlList. The control identifiers are defined by the
* V4L2 specification (V4L2_CID_*).
* *
* If any control in \a ids is not supported by the device, is disabled (i.e. * If any control in \a ids is not supported by the device, is disabled (i.e.
* has the V4L2_CTRL_FLAG_DISABLED flag set), or if any other error occurs * has the V4L2_CTRL_FLAG_DISABLED flag set), or if any other error occurs
@ -612,18 +613,13 @@ ControlList CameraSensor::getControls(const std::vector<uint32_t> &ids)
} }
/** /**
* \fn CameraSensor::properties() * \brief Write V4L2 controls to the sensor
* \brief Retrieve the camera sensor properties
* \return The list of camera sensor properties
*/
/**
* \brief Write controls to the sensor
* \param[in] ctrls The list of controls to write * \param[in] ctrls The list of controls to write
* *
* This method writes the value of all controls contained in \a ctrls, and * This method writes the value of all controls contained in \a ctrls, and
* stores the values actually applied to the device in the corresponding * stores the values actually applied to the device in the corresponding \a
* \a ctrls entry. * ctrls entry. The control identifiers are defined by the V4L2 specification
* (V4L2_CID_*).
* *
* If any control in \a ctrls is not supported by the device, is disabled (i.e. * If any control in \a ctrls is not supported by the device, is disabled (i.e.
* has the V4L2_CTRL_FLAG_DISABLED flag set), is read-only, or if any other * has the V4L2_CTRL_FLAG_DISABLED flag set), is read-only, or if any other
@ -646,6 +642,12 @@ int CameraSensor::setControls(ControlList *ctrls)
return subdev_->setControls(ctrls); return subdev_->setControls(ctrls);
} }
/**
* \fn CameraSensor::properties()
* \brief Retrieve the camera sensor properties
* \return The list of camera sensor properties
*/
/** /**
* \brief Assemble and return the camera sensor info * \brief Assemble and return the camera sensor info
* \param[out] info The camera sensor info * \param[out] info The camera sensor info