summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiklas Söderlund <niklas.soderlund@ragnatech.se>2019-02-21 00:34:41 +0100
committerNiklas Söderlund <niklas.soderlund@ragnatech.se>2019-02-25 23:12:49 +0100
commit9a37b4c5a8452afd3cf19dc915c5460408171e5f (patch)
tree22b451290e1b1c8a7c85e450c3aaaf99ed841b25
parent143b5cc33f356b7744865496d78d5979f70e9208 (diff)
libcamera: pipeline_handler: extend documentation for configureStreams()
Extend the documentation to explicitly state that the pipeline handler implementations are responsible for validating that the requested configuration can be exactly satisfied by the hardware. Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
-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.
*/