From 9a37b4c5a8452afd3cf19dc915c5460408171e5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niklas=20S=C3=B6derlund?= Date: Thu, 21 Feb 2019 00:34:41 +0100 Subject: libcamera: pipeline_handler: extend documentation for configureStreams() MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Laurent Pinchart --- src/libcamera/pipeline_handler.cpp | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'src/libcamera/pipeline_handler.cpp') 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. */ -- cgit v1.2.1