py: MappedFrameBuffer: Add type hints & docs
Add a few type hints and (minimal) docs to MappedFrameBuffer. Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
This commit is contained in:
parent
9e4388cca5
commit
19d870d6d8
1 changed files with 9 additions and 2 deletions
|
@ -1,8 +1,14 @@
|
||||||
# SPDX-License-Identifier: LGPL-2.1-or-later
|
# SPDX-License-Identifier: LGPL-2.1-or-later
|
||||||
# Copyright (C) 2022, Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
|
# Copyright (C) 2022, Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
|
||||||
|
|
||||||
|
import libcamera
|
||||||
|
from typing import Tuple
|
||||||
|
|
||||||
class MappedFrameBuffer:
|
class MappedFrameBuffer:
|
||||||
def __init__(self, fb):
|
"""
|
||||||
|
Provides memoryviews for the FrameBuffer's planes
|
||||||
|
"""
|
||||||
|
def __init__(self, fb: libcamera.FrameBuffer):
|
||||||
self.__fb = fb
|
self.__fb = fb
|
||||||
|
|
||||||
def __enter__(self):
|
def __enter__(self):
|
||||||
|
@ -70,5 +76,6 @@ class MappedFrameBuffer:
|
||||||
mm.close()
|
mm.close()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def planes(self):
|
def planes(self) -> Tuple[memoryview, ...]:
|
||||||
|
"""memoryviews for the planes"""
|
||||||
return self.__planes
|
return self.__planes
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue