From patchwork Fri Mar 19 16:40:46 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marian Cichy X-Patchwork-Id: 11630 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 0B0D3C32E1 for ; Fri, 19 Mar 2021 16:40:51 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 6CB4B68D62; Fri, 19 Mar 2021 17:40:50 +0100 (CET) Received: from metis.ext.pengutronix.de (metis.ext.pengutronix.de [IPv6:2001:67c:670:201:290:27ff:fe1d:cc33]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 26F7B6051E for ; Fri, 19 Mar 2021 17:40:49 +0100 (CET) Received: from dude02.hi.pengutronix.de ([2001:67c:670:100:1d::28]) by metis.ext.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1lNIB6-0004V6-FM; Fri, 19 Mar 2021 17:40:48 +0100 Received: from mci by dude02.hi.pengutronix.de with local (Exim 4.92) (envelope-from ) id 1lNIB6-0001Vd-6J; Fri, 19 Mar 2021 17:40:48 +0100 From: Marian Cichy To: libcamera-devel@lists.libcamera.org Date: Fri, 19 Mar 2021 17:40:46 +0100 Message-Id: <20210319164046.5626-1-m.cichy@pengutronix.de> X-Mailer: git-send-email 2.29.2 MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2001:67c:670:100:1d::28 X-SA-Exim-Mail-From: mci@pengutronix.de X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: libcamera-devel@lists.libcamera.org Subject: [libcamera-devel] [PATCH] libcamera: controls: Extend docs how to identify controls from ControlList X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: graphics@pengutronix.de, Marian Cichy Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Informations how to identify Controls from a ControlList is quite scattered around the documentation and not clear if one reads about the ControlList. Referring to ControlId and ControlIdMap right in the detailed description is probably very helpful. Signed-off-by: Marian Cichy --- src/libcamera/controls.cpp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp index c58ed394..b5253f83 100644 --- a/src/libcamera/controls.cpp +++ b/src/libcamera/controls.cpp @@ -805,6 +805,10 @@ ControlList::ControlList() * For ControlList containing libcamera controls, a global map of all libcamera * controls is provided by controls::controls and can be used as the \a idmap * argument. + * + * To identify a Control from the ControlList, one needs to find the ControlId + * from the numerical control id saved in this list. A global ControlIdMap + * of all libcamera controls is provided by controls::controls. */ ControlList::ControlList(const ControlIdMap &idmap, ControlValidator *validator) : validator_(validator), idmap_(&idmap), infoMap_(nullptr)