Skip to content

Commit

Permalink
Minor docstring fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
crnbaker committed Apr 1, 2022
1 parent 4d382da commit 4b49810
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ It is based on (and includes) Magewell's Windows SDK and is therefore Windows on
that for testing and development that does not depend on the SDK's Windows .dll files, so `pymagwell` can also be
installed on macOS and Linux.

* [GitHub page](https://github.com/KCL-BMEIS/pymagewell)
* [API reference documentation](https://kcl-bmeis.github.io/pymagewell/)
* [PyPI page](https://pypi.org/project/pymagewell/)

Expand Down
1 change: 1 addition & 0 deletions pymagewell/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
that for testing and development that does not depend on the SDK's Windows .dll files, so `pymagwell` can also be
installed on macOS and Linux.
* [GitHub page](https://github.com/KCL-BMEIS/pymagewell)
* [API reference documentation](https://kcl-bmeis.github.io/pymagewell/)
* [PyPI page](https://pypi.org/project/pymagewell/)
Expand Down
3 changes: 3 additions & 0 deletions pymagewell/pro_capture_device/device_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@


class ColourFormat(Enum):
""" Enumeration of the supported colour formats. """
UNK = MWFOURCC_UNK
GREY = MWFOURCC_GREY
Y800 = MWFOURCC_Y800
Expand Down Expand Up @@ -119,6 +120,7 @@ class AspectRatio:


class TransferMode(Enum):
""" Enumeration of the supported methods for triggering the transfer of frames to the PC. """
TIMER = 0
""" Transferred are triggered by a software timer event, allowing arbitrary frame rates. This is the only mode
supported by MockProCaptureDevice. """
Expand Down Expand Up @@ -173,6 +175,7 @@ def as_datetime(self, frame_period_s: float) -> datetime:

@dataclass
class ProCaptureSettings:
""" Settings for the ProCapture device. """
dimensions: ImageSizeInPixels = ImageSizeInPixels(1920, 1080)
"""The dimensions of the frames to be acquired in pixels."""
color_format: ColourFormat = ColourFormat.BGR24
Expand Down

0 comments on commit 4b49810

Please sign in to comment.