Skip to content

Documentation update for ColorConverter #5295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 2, 2021
Merged

Documentation update for ColorConverter #5295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions shared-bindings/displayio/ColorConverter.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ STATIC mp_obj_t displayio_colorconverter_obj_convert(mp_obj_t self_in, mp_obj_t
MP_DEFINE_CONST_FUN_OBJ_2(displayio_colorconverter_convert_obj, displayio_colorconverter_obj_convert);

//| dither: bool
//| """When true the color converter dithers the output by adding random noise when
//| """When `True` the ColorConverter dithers the output by adding random noise when
//| truncating to display bitdepth"""
//|
STATIC mp_obj_t displayio_colorconverter_obj_get_dither(mp_obj_t self_in) {
Expand All @@ -111,8 +111,11 @@ const mp_obj_property_t displayio_colorconverter_dither_obj = {
MP_ROM_NONE},
};

//| def make_transparent(self, pixel: int) -> None:
//| """Sets a pixel to not opaque."""
//| def make_transparent(self, color: int) -> None:
//| """Set the transparent color or index for the ColorConverter. This will
//| raise an Exception if there is already a selected transparent index.
//|
//| :param int color: The color to be transparent"""
//|
STATIC mp_obj_t displayio_colorconverter_make_transparent(mp_obj_t self_in, mp_obj_t transparent_color_obj) {
displayio_colorconverter_t *self = MP_OBJ_TO_PTR(self_in);
Expand All @@ -123,8 +126,10 @@ STATIC mp_obj_t displayio_colorconverter_make_transparent(mp_obj_t self_in, mp_o
}
MP_DEFINE_CONST_FUN_OBJ_2(displayio_colorconverter_make_transparent_obj, displayio_colorconverter_make_transparent);

//| def make_opaque(self, pixel: int) -> None:
//| """Sets a pixel to opaque."""
//| def make_opaque(self, color: int) -> None:
//| """Make the ColorConverter be opaque and have no transparent pixels.
//|
//| :param int color: [IGNORED] Use any value"""
//|
STATIC mp_obj_t displayio_colorconverter_make_opaque(mp_obj_t self_in, mp_obj_t transparent_color_obj) {
displayio_colorconverter_t *self = MP_OBJ_TO_PTR(self_in);
Expand Down