diff options
| author | DavePutz <dwputz@gmail.com> | 2020-05-19 10:32:32 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-19 10:32:32 -0500 |
| commit | 7fa5009674c7741436fd45a3d2009019280aa6f6 (patch) | |
| tree | 9b9197adc9dfc2a7f7a7466abcfc2259f842c16a /shared-bindings/_pixelbuf/__init__.c | |
| parent | 114f06d8250b4250a7c035f3bb1a2820ca2720d2 (diff) | |
| parent | 2c2b53303d17e07daa8f7a61740835d30f671a18 (diff) | |
Merge pull request #4 from adafruit/master
merge from adafruit
Diffstat (limited to 'shared-bindings/_pixelbuf/__init__.c')
| -rw-r--r-- | shared-bindings/_pixelbuf/__init__.c | 29 |
1 files changed, 9 insertions, 20 deletions
diff --git a/shared-bindings/_pixelbuf/__init__.c b/shared-bindings/_pixelbuf/__init__.c index 744a8a2b8..bfd479fde 100644 --- a/shared-bindings/_pixelbuf/__init__.c +++ b/shared-bindings/_pixelbuf/__init__.c @@ -33,33 +33,22 @@ #include "shared-bindings/_pixelbuf/PixelBuf.h" -//| :mod:`_pixelbuf` --- Fast RGB(W) pixel buffer and helpers -//| =========================================================== - -//| .. module:: _pixelbuf -//| :synopsis: A fast RGB(W) pixel buffer library for like NeoPixel and DotStar. +//| """A fast RGB(W) pixel buffer library for like NeoPixel and DotStar. //| //| The `_pixelbuf` module provides the :py:class:`PixelBuf` class to accelerate //| RGB(W) strip/matrix manipulation, such as DotStar and Neopixel. //| -//| Byteorders are configured with strings, such as "RGB" or "RGBD". -//| TODO: Pull in docs from pypixelbuf. - -//| Libraries -//| -//| .. toctree:: -//| :maxdepth: 3 -//| -//| PixelBuf - +//| Byteorders are configured with strings, such as "RGB" or "RGBD".""" +// TODO: Pull in docs from pypixelbuf. -//| .. function:: colorwheel(n) +//| def colorwheel(n: int) -> Any: +//| """C implementation of the common wheel() function found in many examples. +//| Returns the colorwheel RGB value as an integer value for n (usable in :py:class:`PixelBuf`, neopixel, and dotstar).""" +//| ... //| -//| C implementation of the common wheel() function found in many examples. -//| Returns the colorwheel RGB value as an integer value for n (usable in :py:class:`PixelBuf`, neopixel, and dotstar). +//| def wheel(n: Any) -> Any: +//| """Use of wheel() is deprecated. Please use colorwheel().""" //| -//| .. function:: wheel(n) -//| Use of wheel() is deprecated. Please use colorwheel(). STATIC mp_obj_t pixelbuf_colorwheel(mp_obj_t n) { return MP_OBJ_NEW_SMALL_INT(colorwheel(MP_OBJ_IS_SMALL_INT(n) ? MP_OBJ_SMALL_INT_VALUE(n) : mp_obj_float_get(n))); |
