summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/libcamera/pipeline_handler.cpp8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index 616838fe..dad0a296 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -136,6 +136,14 @@ PipelineHandler::~PipelineHandler()
* is the Camera class which will receive configuration to apply from the
* application.
*
+ * Each pipeline handler implementation is responsible for validating
+ * that the configuration requested in \a config can be achieved
+ * exactly. Any difference in pixel format, frame size or any other
+ * parameter shall result in the -EINVAL error being returned, and no
+ * change in configuration being applied to the pipeline. If
+ * configuration of a subset of the streams can't be satisfied, the
+ * whole configuration is considered invalid.
+ *
* \return 0 on success or a negative error code on error.
*/