Skip to content

Commit c00ea31

Browse files
committed
add class docstring
1 parent e2f06f6 commit c00ea31

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

shared-bindings/tilepalettemapper/TilePaletteMapper.c

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,20 @@
1313
#include "shared-bindings/displayio/Palette.h"
1414
#include "shared-bindings/tilepalettemapper/TilePaletteMapper.h"
1515

16+
//| class TilePaletteMapper:
17+
//| """Contains a displayio.Palette a series of mappings from one palette color_index to another palette color_index.
18+
//| One mapping for tile in a 2D grid. Can be set as the pixel_shader for a TileGrid to re-map the colors for
19+
//| spedific tile(s) within the TileGrid."""
20+
//|
21+
//| def __init__(self, palette: displayio.Palette, width: int, height: int) -> None:
22+
//| """Create a TilePaletteMApper object to store a set color mappings for tiles.
23+
//|
24+
//| :param displayio.Palette palette: The palette to get mapped colors from.
25+
//| :param int width: The width of the grid in tiles.
26+
//| :param int height: The height of the grid in tiles.
27+
//| """
28+
//| ...
29+
//|
1630
static mp_obj_t tilepalettemapper_tilepalettemapper_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
1731
enum { ARG_palette, ARG_width, ARG_height };
1832
static const mp_arg_t allowed_args[] = {

0 commit comments

Comments
 (0)