:mod:`_pixelbuf`
================

.. py:module:: _pixelbuf

.. autoapi-nested-parse::

   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".





.. function:: 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).


.. function:: wheel(n: Any) -> Any

   Use of wheel() is deprecated. Please use colorwheel().


.. py:class:: PixelBuf(size: int, *, byteorder: str = 'BGR', brightness: float = 0, auto_write: bool = False, header: bytes = b'', trailer: bytes = b'')

   A fast RGB[W] pixel buffer for LED and similar devices.

   .. attribute:: bpp
      :annotation: :Any

      The number of bytes per pixel in the buffer (read-only)


   .. attribute:: brightness
      :annotation: :Any

      Float value between 0 and 1.  Output brightness.

      When brightness is less than 1.0, a second buffer will be used to store the color values
      before they are adjusted for brightness.


   .. attribute:: auto_write
      :annotation: :Any

      Whether to automatically write the pixels after each update.


   .. attribute:: byteorder
      :annotation: :Any

      byteorder string for the buffer (read-only)


   .. method:: show(self)


      Transmits the color data to the pixels so that they are shown. This is done automatically
      when `auto_write` is True.



.. function:: fill(color: Any) -> Any

   Fills the given pixelbuf with the given color.