summaryrefslogtreecommitdiff
path: root/shared-bindings/framebufferio
diff options
context:
space:
mode:
authordherrada <dylan.herrada@gmail.com>2020-05-07 11:56:46 -0400
committerdherrada <dylan.herrada@gmail.com>2020-05-07 11:56:46 -0400
commita3d5adb43c897d591baabaaf1e7ef83deedbd3ce (patch)
treec0e05dc021779832eb0b498c2a096c2dc3b212c1 /shared-bindings/framebufferio
parent2ebe3035dff0ce66b2fe65eb91d6889c4ba93b5c (diff)
Did _eve, fontio, framebufferio, and frequencyio
Diffstat (limited to 'shared-bindings/framebufferio')
-rw-r--r--shared-bindings/framebufferio/FramebufferDisplay.c109
-rw-r--r--shared-bindings/framebufferio/__init__.c4
2 files changed, 54 insertions, 59 deletions
diff --git a/shared-bindings/framebufferio/FramebufferDisplay.c b/shared-bindings/framebufferio/FramebufferDisplay.c
index 9ff6cc12d..5e63b988e 100644
--- a/shared-bindings/framebufferio/FramebufferDisplay.c
+++ b/shared-bindings/framebufferio/FramebufferDisplay.c
@@ -40,23 +40,24 @@
#include "shared-module/displayio/__init__.h"
#include "supervisor/shared/translate.h"
-//| .. currentmodule:: framebufferio
+//| class FramebufferDisplay:
+//| """.. currentmodule:: framebufferio
//|
-//| :class:`FramebufferDisplay` -- Manage updating a display with framebuffer in RAM
-//| ================================================================================
+//| :class:`FramebufferDisplay` -- Manage updating a display with framebuffer in RAM
+//| ================================================================================
//|
-//| This initializes a display and connects it into CircuitPython. Unlike other
-//| objects in CircuitPython, Display objects live until `displayio.release_displays()`
-//| is called. This is done so that CircuitPython can use the display itself.
+//| This initializes a display and connects it into CircuitPython. Unlike other
+//| objects in CircuitPython, Display objects live until `displayio.release_displays()`
+//| is called. This is done so that CircuitPython can use the display itself."""
//|
-//| .. class:: FramebufferDisplay(framebuffer, *, rotation=0, auto_refresh=True)
+//| def __init__(self, framebuffer: Any, *, rotation: int = 0, auto_refresh: bool = True):
+//| """Create a Display object with the given framebuffer (a buffer, array, ulab.array, etc)
//|
-//| Create a Display object with the given framebuffer (a buffer, array, ulab.array, etc)
-//|
-//| :param framebuffer: The framebuffer that the display is connected to
-//| :type framebuffer: any core object implementing the framebuffer protocol
-//| :param bool auto_refresh: Automatically refresh the screen
-//| :param int rotation: The rotation of the display in degrees clockwise. Must be in 90 degree increments (0, 90, 180, 270)
+//| :param framebuffer: The framebuffer that the display is connected to
+//| :type framebuffer: any core object implementing the framebuffer protocol
+//| :param bool auto_refresh: Automatically refresh the screen
+//| :param int rotation: The rotation of the display in degrees clockwise. Must be in 90 degree increments (0, 90, 180, 270)"""
+//| ...
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_framebuffer, ARG_rotation, ARG_auto_refresh, NUM_ARGS };
@@ -96,12 +97,12 @@ static framebufferio_framebufferdisplay_obj_t* native_display(mp_obj_t display_o
return MP_OBJ_TO_PTR(native_display);
}
-//| .. method:: show(group)
-//|
-//| Switches to displaying the given group of layers. When group is None, the default
-//| CircuitPython terminal will be shown.
+//| def show(self, group: Group) -> Any:
+//| """Switches to displaying the given group of layers. When group is None, the default
+//| CircuitPython terminal will be shown.
//|
-//| :param Group group: The group to show.
+//| :param Group group: The group to show."""
+//| ...
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_show(mp_obj_t self_in, mp_obj_t group_in) {
framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -118,21 +119,21 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_obj_show(mp_obj_t self_in, mp_o
}
MP_DEFINE_CONST_FUN_OBJ_2(framebufferio_framebufferdisplay_show_obj, framebufferio_framebufferdisplay_obj_show);
-//| .. method:: refresh(*, target_frames_per_second=60, minimum_frames_per_second=1)
-//|
-//| When auto refresh is off, waits for the target frame rate and then refreshes the display,
-//| returning True. If the call has taken too long since the last refresh call for the given
-//| target frame rate, then the refresh returns False immediately without updating the screen to
-//| hopefully help getting caught up.
+//| def refresh(self, *, target_frames_per_second: int = 60, minimum_frames_per_second: int = 1) -> Any:
+//| """When auto refresh is off, waits for the target frame rate and then refreshes the display,
+//| returning True. If the call has taken too long since the last refresh call for the given
+//| target frame rate, then the refresh returns False immediately without updating the screen to
+//| hopefully help getting caught up.
//|
-//| If the time since the last successful refresh is below the minimum frame rate, then an
-//| exception will be raised. Set minimum_frames_per_second to 0 to disable.
+//| If the time since the last successful refresh is below the minimum frame rate, then an
+//| exception will be raised. Set minimum_frames_per_second to 0 to disable.
//|
-//| When auto refresh is on, updates the display immediately. (The display will also update
-//| without calls to this.)
+//| When auto refresh is on, updates the display immediately. (The display will also update
+//| without calls to this.)
//|
-//| :param int target_frames_per_second: How many times a second `refresh` should be called and the screen updated.
-//| :param int minimum_frames_per_second: The minimum number of times the screen should be updated per second.
+//| :param int target_frames_per_second: How many times a second `refresh` should be called and the screen updated.
+//| :param int minimum_frames_per_second: The minimum number of times the screen should be updated per second."""
+//| ...
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_refresh(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_target_frames_per_second, ARG_minimum_frames_per_second };
@@ -153,9 +154,8 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_obj_refresh(size_t n_args, cons
}
MP_DEFINE_CONST_FUN_OBJ_KW(framebufferio_framebufferdisplay_refresh_obj, 1, framebufferio_framebufferdisplay_obj_refresh);
-//| .. attribute:: auto_refresh
-//|
-//| True when the display is refreshed automatically.
+//| auto_refresh: Any = ...
+//| """True when the display is refreshed automatically."""
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_auto_refresh(mp_obj_t self_in) {
framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -179,11 +179,10 @@ const mp_obj_property_t framebufferio_framebufferdisplay_auto_refresh_obj = {
(mp_obj_t)&mp_const_none_obj},
};
-//| .. attribute:: brightness
-//|
-//| The brightness of the display as a float. 0.0 is off and 1.0 is full brightness. When
+//| brightness: Any = ...
+//| """The brightness of the display as a float. 0.0 is off and 1.0 is full brightness. When
//| `auto_brightness` is True, the value of `brightness` will change automatically.
-//| If `brightness` is set, `auto_brightness` will be disabled and will be set to False.
+//| If `brightness` is set, `auto_brightness` will be disabled and will be set to False."""
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_brightness(mp_obj_t self_in) {
framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -217,12 +216,11 @@ const mp_obj_property_t framebufferio_framebufferdisplay_brightness_obj = {
(mp_obj_t)&mp_const_none_obj},
};
-//| .. attribute:: auto_brightness
-//|
-//| True when the display brightness is adjusted automatically, based on an ambient
+//| auto_brightness: Any = ...
+//| """True when the display brightness is adjusted automatically, based on an ambient
//| light sensor or other method. Note that some displays may have this set to True by default,
//| but not actually implement automatic brightness adjustment. `auto_brightness` is set to False
-//| if `brightness` is set manually.
+//| if `brightness` is set manually."""
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_auto_brightness(mp_obj_t self_in) {
framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -249,9 +247,8 @@ const mp_obj_property_t framebufferio_framebufferdisplay_auto_brightness_obj = {
(mp_obj_t)&mp_const_none_obj},
};
-//| .. attribute:: width
-//|
-//| Gets the width of the framebuffer
+//| width: Any = ...
+//| """Gets the width of the framebuffer"""
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_width(mp_obj_t self_in) {
framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -266,9 +263,8 @@ const mp_obj_property_t framebufferio_framebufferdisplay_width_obj = {
(mp_obj_t)&mp_const_none_obj},
};
-//| .. attribute:: height
-//|
-//| Gets the height of the framebuffer
+//| height: Any = ...
+//| """Gets the height of the framebuffer"""
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_height(mp_obj_t self_in) {
framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -283,9 +279,8 @@ const mp_obj_property_t framebufferio_framebufferdisplay_height_obj = {
(mp_obj_t)&mp_const_none_obj},
};
-//| .. attribute:: rotation
-//|
-//| The rotation of the display as an int in degrees.
+//| rotation: Any = ...
+//| """The rotation of the display as an int in degrees."""
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_rotation(mp_obj_t self_in) {
framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -307,9 +302,8 @@ const mp_obj_property_t framebufferio_framebufferdisplay_rotation_obj = {
(mp_obj_t)&mp_const_none_obj},
};
-//| .. attribute:: framebuffer
-//|
-//| The framebuffer being used by the display
+//| framebuffer: Any = ...
+//| """The framebuffer being used by the display"""
//|
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_framebuffer(mp_obj_t self_in) {
@@ -326,12 +320,13 @@ const mp_obj_property_t framebufferio_framebufferframebuffer_obj = {
};
-//| .. method:: fill_row(y, buffer)
+//| def fill_row(self, y: int, buffer: bytearray) -> Any:
+//| """Extract the pixels from a single row
//|
-//| Extract the pixels from a single row
+//| :param int y: The top edge of the area
+//| :param bytearray buffer: The buffer in which to place the pixel data"""
+//| ...
//|
-//| :param int y: The top edge of the area
-//| :param bytearray buffer: The buffer in which to place the pixel data
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_fill_row(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_y, ARG_buffer };
static const mp_arg_t allowed_args[] = {
diff --git a/shared-bindings/framebufferio/__init__.c b/shared-bindings/framebufferio/__init__.c
index 88f69bb2c..50725c515 100644
--- a/shared-bindings/framebufferio/__init__.c
+++ b/shared-bindings/framebufferio/__init__.c
@@ -28,7 +28,7 @@
#include "shared-bindings/framebufferio/__init__.h"
#include "shared-bindings/framebufferio/FramebufferDisplay.h"
-//| :mod:`framebufferio` --- Native framebuffer display driving
+//| """:mod:`framebufferio` --- Native framebuffer display driving
//| =========================================================================
//|
//| .. module:: framebufferio
@@ -46,7 +46,7 @@
//| .. toctree::
//| :maxdepth: 3
//|
-//| FramebufferDisplay
+//| FramebufferDisplay"""
//|
#if CIRCUITPY_FRAMEBUFFERIO