summaryrefslogtreecommitdiff
path: root/shared-bindings/_stage
diff options
context:
space:
mode:
authordherrada <dylan.herrada@gmail.com>2020-05-11 13:40:02 -0400
committerdherrada <dylan.herrada@gmail.com>2020-05-11 13:40:02 -0400
commit603df58f971743bc36b9e391cd5fb04812262533 (patch)
tree1ea3eefab2ba5f8d133cde5996a1244c159579df /shared-bindings/_stage
parentc7a9d49cba38499ec6701fdfef0c14e1dd5503a8 (diff)
Did stage, socket, storage
Diffstat (limited to 'shared-bindings/_stage')
-rw-r--r--shared-bindings/_stage/Layer.c45
-rw-r--r--shared-bindings/_stage/Text.c37
-rw-r--r--shared-bindings/_stage/__init__.c12
3 files changed, 48 insertions, 46 deletions
diff --git a/shared-bindings/_stage/Layer.c b/shared-bindings/_stage/Layer.c
index 12028b131..437114cd3 100644
--- a/shared-bindings/_stage/Layer.c
+++ b/shared-bindings/_stage/Layer.c
@@ -30,25 +30,26 @@
#include "Layer.h"
#include "supervisor/shared/translate.h"
-//| .. currentmodule:: _stage
+//| class Layer:
+//| """.. currentmodule:: _stage
//|
-//| :class:`Layer` -- Keep information about a single layer of graphics
-//| ===================================================================
+//| :class:`Layer` -- Keep information about a single layer of graphics
+//| ==================================================================="""
//|
-//| .. class:: Layer(width, height, graphic, palette, [grid])
+//| def __init__(self, width: int, height: int, graphic: bytearray, palette: bytearray, grid: bytearray):
+//| """Keep internal information about a layer of graphics (either a
+//| ``Grid`` or a ``Sprite``) in a format suitable for fast rendering
+//| with the ``render()`` function.
//|
-//| Keep internal information about a layer of graphics (either a
-//| ``Grid`` or a ``Sprite``) in a format suitable for fast rendering
-//| with the ``render()`` function.
+//| :param int width: The width of the grid in tiles, or 1 for sprites.
+//| :param int height: The height of the grid in tiles, or 1 for sprites.
+//| :param bytearray graphic: The graphic data of the tiles.
+//| :param bytearray palette: The color palette to be used.
+//| :param bytearray grid: The contents of the grid map.
//|
-//| :param int width: The width of the grid in tiles, or 1 for sprites.
-//| :param int height: The height of the grid in tiles, or 1 for sprites.
-//| :param bytearray graphic: The graphic data of the tiles.
-//| :param bytearray palette: The color palette to be used.
-//| :param bytearray grid: The contents of the grid map.
-//|
-//| This class is intended for internal use in the ``stage`` library and
-//| it shouldn't be used on its own.
+//| This class is intended for internal use in the ``stage`` library and
+//| it shouldn't be used on its own."""
+//| ...
//|
STATIC mp_obj_t layer_make_new(const mp_obj_type_t *type, size_t n_args,
const mp_obj_t *args, mp_map_t *kw_args) {
@@ -90,9 +91,9 @@ STATIC mp_obj_t layer_make_new(const mp_obj_type_t *type, size_t n_args,
return MP_OBJ_FROM_PTR(self);
}
-//| .. method:: move(x, y)
-//|
-//| Set the offset of the layer to the specified values.
+//| def move(self, x: Any, y: Any) -> Any:
+//| """Set the offset of the layer to the specified values."""
+//| ...
//|
STATIC mp_obj_t layer_move(mp_obj_t self_in, mp_obj_t x_in, mp_obj_t y_in) {
layer_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -102,10 +103,10 @@ STATIC mp_obj_t layer_move(mp_obj_t self_in, mp_obj_t x_in, mp_obj_t y_in) {
}
STATIC MP_DEFINE_CONST_FUN_OBJ_3(layer_move_obj, layer_move);
-//| .. method:: frame(frame, rotation)
-//|
-//| Set the animation frame of the sprite, and optionally rotation its
-//| graphic.
+//| def frame(self, frame: Any, rotation: Any) -> Any:
+//| """Set the animation frame of the sprite, and optionally rotation its
+//| graphic."""
+//| ...
//|
STATIC mp_obj_t layer_frame(mp_obj_t self_in, mp_obj_t frame_in,
mp_obj_t rotation_in) {
diff --git a/shared-bindings/_stage/Text.c b/shared-bindings/_stage/Text.c
index 49c1d00ca..8797f74db 100644
--- a/shared-bindings/_stage/Text.c
+++ b/shared-bindings/_stage/Text.c
@@ -30,25 +30,26 @@
#include "Text.h"
#include "supervisor/shared/translate.h"
-//| .. currentmodule:: _stage
+//| class Text:
+//| """.. currentmodule:: _stage
//|
-//| :class:`Text` -- Keep information about a single text of text
-//| ==============================================================
+//| :class:`Text` -- Keep information about a single text of text
+//| =============================================================="""
//|
-//| .. class:: Text(width, height, font, palette, chars)
+//| def __init__(self, width: int, height: int, font: bytearray, palette: bytearray, chars: bytearray):
+//| """Keep internal information about a text of text
+//| in a format suitable for fast rendering
+//| with the ``render()`` function.
//|
-//| Keep internal information about a text of text
-//| in a format suitable for fast rendering
-//| with the ``render()`` function.
+//| :param int width: The width of the grid in tiles, or 1 for sprites.
+//| :param int height: The height of the grid in tiles, or 1 for sprites.
+//| :param bytearray font: The font data of the characters.
+//| :param bytearray palette: The color palette to be used.
+//| :param bytearray chars: The contents of the character grid.
//|
-//| :param int width: The width of the grid in tiles, or 1 for sprites.
-//| :param int height: The height of the grid in tiles, or 1 for sprites.
-//| :param bytearray font: The font data of the characters.
-//| :param bytearray palette: The color palette to be used.
-//| :param bytearray chars: The contents of the character grid.
-//|
-//| This class is intended for internal use in the ``stage`` library and
-//| it shouldn't be used on its own.
+//| This class is intended for internal use in the ``stage`` library and
+//| it shouldn't be used on its own."""
+//| ...
//|
STATIC mp_obj_t text_make_new(const mp_obj_type_t *type, size_t n_args,
const mp_obj_t *args, mp_map_t *kw_args) {
@@ -84,9 +85,9 @@ STATIC mp_obj_t text_make_new(const mp_obj_type_t *type, size_t n_args,
return MP_OBJ_FROM_PTR(self);
}
-//| .. method:: move(x, y)
-//|
-//| Set the offset of the text to the specified values.
+//| def move(self, x: Any, y: Any) -> Any:
+//| """Set the offset of the text to the specified values."""
+//| ...
//|
STATIC mp_obj_t text_move(mp_obj_t self_in, mp_obj_t x_in, mp_obj_t y_in) {
text_obj_t *self = MP_OBJ_TO_PTR(self_in);
diff --git a/shared-bindings/_stage/__init__.c b/shared-bindings/_stage/__init__.c
index 4bac280bf..6b5c4fd8b 100644
--- a/shared-bindings/_stage/__init__.c
+++ b/shared-bindings/_stage/__init__.c
@@ -34,7 +34,7 @@
#include "Layer.h"
#include "Text.h"
-//| :mod:`_stage` --- C-level helpers for animation of sprites on a stage
+//| """:mod:`_stage` --- C-level helpers for animation of sprites on a stage
//| =====================================================================
//|
//| .. module:: _stage
@@ -49,11 +49,10 @@
//| :maxdepth: 3
//|
//| Layer
-//| Text
+//| Text"""
//|
-//| .. function:: render(x0, y0, x1, y1, layers, buffer, display[, scale[, background]])
-//|
-//| Render and send to the display a fragment of the screen.
+//| def render(x0: int, y0: int, x1: int, y1: int, layers: list, buffer: bytearray, display: displayio.Display, scale: int, background: int) -> Any:
+//| """Render and send to the display a fragment of the screen.
//|
//| :param int x0: Left edge of the fragment.
//| :param int y0: Top edge of the fragment.
@@ -70,7 +69,8 @@
//| valid.
//|
//| This function is intended for internal use in the ``stage`` library
-//| and all the necessary checks are performed there.
+//| and all the necessary checks are performed there."""
+//|
STATIC mp_obj_t stage_render(size_t n_args, const mp_obj_t *args) {
uint16_t x0 = mp_obj_get_int(args[0]);
uint16_t y0 = mp_obj_get_int(args[1]);