From 19d870d6d8db28da6670f7c077570980eb9af80d Mon Sep 17 00:00:00 2001 From: Tomi Valkeinen Date: Fri, 27 May 2022 17:44:25 +0300 Subject: py: MappedFrameBuffer: Add type hints & docs Add a few type hints and (minimal) docs to MappedFrameBuffer. Signed-off-by: Tomi Valkeinen Reviewed-by: Laurent Pinchart Signed-off-by: Laurent Pinchart --- src/py/libcamera/utils/MappedFrameBuffer.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'src/py') diff --git a/src/py/libcamera/utils/MappedFrameBuffer.py b/src/py/libcamera/utils/MappedFrameBuffer.py index e7dd16ec..fc2726b6 100644 --- a/src/py/libcamera/utils/MappedFrameBuffer.py +++ b/src/py/libcamera/utils/MappedFrameBuffer.py @@ -1,8 +1,14 @@ # SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2022, Tomi Valkeinen +import libcamera +from typing import Tuple + class MappedFrameBuffer: - def __init__(self, fb): + """ + Provides memoryviews for the FrameBuffer's planes + """ + def __init__(self, fb: libcamera.FrameBuffer): self.__fb = fb def __enter__(self): @@ -70,5 +76,6 @@ class MappedFrameBuffer: mm.close() @property - def planes(self): + def planes(self) -> Tuple[memoryview, ...]: + """memoryviews for the planes""" return self.__planes -- cgit v1.2.1