{"id":13090,"url":"https://patchwork.libcamera.org/api/1.1/patches/13090/?format=json","web_url":"https://patchwork.libcamera.org/patch/13090/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20210723040036.32346-5-laurent.pinchart@ideasonboard.com>","date":"2021-07-23T04:00:23","name":"[libcamera-devel,RFC,04/17] libcamera: frame_buffer: Document the FrameBuffer::Private class","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"800b3114c011babb997e378dd595dcb4a863e4aa","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/13090/mbox/","series":[{"id":2270,"url":"https://patchwork.libcamera.org/api/1.1/series/2270/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2270","date":"2021-07-23T04:00:19","name":"libcamera: Replace CameraData with Camera::Private","version":1,"mbox":"https://patchwork.libcamera.org/series/2270/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/13090/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/13090/checks/","tags":{},"headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 209A8C322C\n\tfor ;\n\tFri, 23 Jul 2021 04:00:51 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 6F02E687B3;\n\tFri, 23 Jul 2021 06:00:49 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 48FAE687A4\n\tfor ;\n\tFri, 23 Jul 2021 06:00:44 +0200 (CEST)","from pendragon.lan (62-78-145-57.bb.dnainternet.fi [62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id ECF42255\n\tfor ;\n\tFri, 23 Jul 2021 06:00:43 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"CPnWosNZ\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1627012844;\n\tbh=EgQZAWRXuJZ3TraObXH5yBubwwgOsqbQL/0mjNMWWcE=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=CPnWosNZp9fzW4afGoRd5jHmLmQJB3wxk+O/JvxESnfn3DAnLw+13dCiH5WB5tA26\n\tWsX+ikVtFwmcHuNTqDpAN643Odh3darP4MXP5CAMqBU4KW94JLPOm9q65PwO2/QtGc\n\tFqphcNHI0g1NHaE0SzVs6ULrR35IFqlLwW+FZcaY=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Date":"Fri, 23 Jul 2021 07:00:23 +0300","Message-Id":"<20210723040036.32346-5-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.31.1","In-Reply-To":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>","References":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [RFC PATCH 04/17] libcamera: frame_buffer:\n\tDocument the FrameBuffer::Private class","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"The FrameBuffer::Private class is exposed to pipeline handlers, and is\nthus part of the internal libcamera API. As such, it should be\ndocumented.\n\nSigned-off-by: Laurent Pinchart \n---\n src/libcamera/framebuffer.cpp | 10 ++++++++++\n 1 file changed, 10 insertions(+)","diff":"diff --git a/src/libcamera/framebuffer.cpp b/src/libcamera/framebuffer.cpp\nindex 48d14b31f68d..a59e93fbdf91 100644\n--- a/src/libcamera/framebuffer.cpp\n+++ b/src/libcamera/framebuffer.cpp\n@@ -100,6 +100,16 @@ LOG_DEFINE_CATEGORY(Buffer)\n * \\brief Array of per-plane metadata\n */\n \n+/**\n+ * \\class FrameBuffer::Private\n+ * \\brief Base class for FrameBuffer private data\n+ *\n+ * The FrameBuffer::Private class stores all private data associated with a\n+ * framebuffer. It implements the d-pointer design pattern to hide core\n+ * FrameBuffer data from the public API, and exposes utility functions to\n+ * pipeline handlers.\n+ */\n+\n FrameBuffer::Private::Private()\n \t: request_(nullptr)\n {\n","prefixes":["libcamera-devel","RFC","04/17"]}