:mod:`gamepadshift`
===================

.. py:module:: gamepadshift

.. autoapi-nested-parse::

   Tracks button presses read through a shift register.

   .. note:: `gamepadshift` is deprecated in CircuitPython 7.0.0 and will be removed in 8.0.0.
      Use `keypad` instead.



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> Adafruit EdgeBadge
    <li> Adafruit PyGamer
    <li> Adafruit Pybadge
    <li> Swan R5
    <li> The Open Book Feather
    </ul>
    </details>
    </p>




.. py:class:: GamePadShift(clock: digitalio.DigitalInOut, data: digitalio.DigitalInOut, latch: digitalio.DigitalInOut)

   Scan buttons for presses through a shift register

   Initializes button scanning routines.

   The ``clock``, ``data`` and ``latch`` parameters are ``DigitalInOut``
   objects connected to the shift register controlling the buttons.

   The button presses are accumulated, until the ``get_pressed`` method
   is called, at which point the button state is cleared, and the new
   button presses start to be recorded.

   Only one `gamepadshift.GamePadShift` may be used at a time.

   .. py:method:: get_pressed() -> int

      Get the status of buttons pressed since the last call and clear it.

      Returns an 8-bit number, with bits that correspond to buttons,
      which have been pressed (or held down) since the last call to this
      function set to 1, and the remaining bits set to 0. Then it clears
      the button state, so that new button presses (or buttons that are
      held down) can be recorded for the next call.


   .. py:method:: deinit() -> None

      Disable button scanning.