summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2019-09-28 16:22:24 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2019-10-05 20:02:51 +0300
commitace50f75a4d4c10c0deb90fc857525b565cdd8c9 (patch)
treeb78482ea5b759f6b3cc37d45ad75594f387445ab /src
parentf1ab117e81e55b9b030dd921394dde294f7c3dc0 (diff)
libcamera: controls: Rename ControlInfo to ControlRange
The ControlInfo class stores a range of valid values for a control. Its name is vague, as "info" has multiple meanings. Rename it to ControlRange. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Jacopo Mondi <jacopo@jmondi.org> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Diffstat (limited to 'src')
-rw-r--r--src/libcamera/controls.cpp28
1 files changed, 14 insertions, 14 deletions
diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index 526b7755..a7e9d069 100644
--- a/src/libcamera/controls.cpp
+++ b/src/libcamera/controls.cpp
@@ -312,42 +312,42 @@ Control<int64_t>::Control(unsigned int id, const char *name)
#endif /* __DOXYGEN__ */
/**
- * \class ControlInfo
- * \brief Describe the information and capabilities of a Control
+ * \class ControlRange
+ * \brief Describe the limits of valid values for a Control
*
- * The ControlInfo represents control specific meta-data which is constant on a
- * per camera basis. ControlInfo classes are constructed by pipeline handlers
- * to expose the controls they support and the metadata needed to utilise those
- * controls.
+ * The ControlRange expresses the constraints on valid values for a control.
+ * The constraints depend on the object the control applies to, and are
+ * constant for the lifetime of that object. They are typically constructed by
+ * pipeline handlers to describe the controls they support.
*/
/**
- * \brief Construct a ControlInfo with minimum and maximum range parameters
+ * \brief Construct a ControlRange with minimum and maximum range parameters
* \param[in] min The control minimum value
* \param[in] max The control maximum value
*/
-ControlInfo::ControlInfo(const ControlValue &min,
- const ControlValue &max)
+ControlRange::ControlRange(const ControlValue &min,
+ const ControlValue &max)
: min_(min), max_(max)
{
}
/**
- * \fn ControlInfo::min()
+ * \fn ControlRange::min()
* \brief Retrieve the minimum value of the control
* \return A ControlValue with the minimum value for the control
*/
/**
- * \fn ControlInfo::max()
+ * \fn ControlRange::max()
* \brief Retrieve the maximum value of the control
* \return A ControlValue with the maximum value for the control
*/
/**
- * \brief Provide a string representation of the ControlInfo
+ * \brief Provide a string representation of the ControlRange
*/
-std::string ControlInfo::toString() const
+std::string ControlRange::toString() const
{
std::stringstream ss;
@@ -358,7 +358,7 @@ std::string ControlInfo::toString() const
/**
* \typedef ControlInfoMap
- * \brief A map of ControlId to ControlInfo
+ * \brief A map of ControlId to ControlRange
*/
/**