summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNaushir Patuck <naush@raspberrypi.com>2020-04-24 11:46:56 +0100
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2020-04-27 20:18:06 +0300
commit47d09a13b3acead2cd6007d6b6022931756c9ae7 (patch)
tree993112988294f5c7efd8bd988bc9d9c64f804b5e
parent1957aa641dc9bb635fbedf28c44215ddc496c006 (diff)
libcamera: control_ids: Add comment to specify control direction
Document that controls are bi-directional by default. If a control is only returned in metadata, this must be specified in the control's description. 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> Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
-rw-r--r--src/libcamera/control_ids.cpp.in3
-rw-r--r--src/libcamera/control_ids.yaml2
2 files changed, 5 insertions, 0 deletions
diff --git a/src/libcamera/control_ids.cpp.in b/src/libcamera/control_ids.cpp.in
index 99c511d0..cba6258d 100644
--- a/src/libcamera/control_ids.cpp.in
+++ b/src/libcamera/control_ids.cpp.in
@@ -33,6 +33,9 @@ ${controls_def}
/**
* \brief List of all supported libcamera controls
+ *
+ * Unless otherwise stated, all controls are bi-directional, i.e. they can be
+ * set through Request::controls() and returned out through Request::metadata().
*/
extern const ControlIdMap controls {
${controls_map}
diff --git a/src/libcamera/control_ids.yaml b/src/libcamera/control_ids.yaml
index 4befec74..bcbab195 100644
--- a/src/libcamera/control_ids.yaml
+++ b/src/libcamera/control_ids.yaml
@@ -4,6 +4,8 @@
#
%YAML 1.2
---
+# Unless otherwise stated, all controls are bi-directional, i.e. they can be
+# set through Request::controls() and returned out through Request::metadata().
controls:
- AeEnable:
type: bool