:mod:`imagecapture`
===================

.. py:module:: imagecapture

.. autoapi-nested-parse::

   Support for "Parallel capture" interfaces



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> ATMegaZero ESP32-S2
    <li> Adafruit Feather ESP32-S2 TFT
    <li> Adafruit Feather ESP32S2
    <li> Adafruit Feather RP2040
    <li> Adafruit FunHouse
    <li> Adafruit Grand Central M4 Express
    <li> Adafruit ItsyBitsy RP2040
    <li> Adafruit KB2040
    <li> Adafruit Macropad RP2040
    <li> Adafruit MagTag
    <li> Adafruit Metro ESP32S2
    <li> Adafruit QT Py ESP32S2
    <li> Adafruit QT Py RP2040
    <li> Adafruit QT2040 Trinkey
    <li> Arduino Nano RP2040 Connect
    <li> Artisense Reference Design RD00
    <li> BastWiFi
    <li> Challenger NB RP2040 WiFi
    <li> Challenger RP2040 LTE
    <li> Challenger RP2040 WiFi
    <li> CrumpS2
    <li> Cytron Maker Nano RP2040
    <li> Cytron Maker Pi RP2040
    <li> ESP 12k NodeMCU
    <li> EncoderPad RP2040
    <li> Feather ESP32S2 without PSRAM
    <li> FeatherS2
    <li> FeatherS2 Neo
    <li> FeatherS2 PreRelease
    <li> Franzininho WIFI w/Wroom
    <li> Franzininho WIFI w/Wrover
    <li> Gravitech Cucumber M
    <li> Gravitech Cucumber MS
    <li> Gravitech Cucumber R
    <li> Gravitech Cucumber RS
    <li> HMI-DevKit-1.1
    <li> Kaluga 1
    <li> LILYGO TTGO T8 ESP32-S2 w/Display
    <li> MORPHEANS MorphESP-240
    <li> Melopero Shake RP2040
    <li> MicroDev microS2
    <li> Oak Dev Tech BREAD2040
    <li> Oak Dev Tech PixelWing ESP32S2
    <li> Pimoroni Interstate 75
    <li> Pimoroni Keybow 2040
    <li> Pimoroni PGA2040
    <li> Pimoroni Pico LiPo (16MB)
    <li> Pimoroni Pico LiPo (4MB)
    <li> Pimoroni PicoSystem
    <li> Pimoroni Plasma 2040
    <li> Pimoroni Tiny 2040
    <li> PyKey60
    <li> RP2040 Stamp
    <li> Raspberry Pi Pico
    <li> S2Mini
    <li> S2Pico
    <li> Saola 1 w/Wroom
    <li> Saola 1 w/Wrover
    <li> SparkFun MicroMod RP2040 Processor
    <li> SparkFun Pro Micro RP2040
    <li> SparkFun Thing Plus - RP2040
    <li> Targett Module Clip w/Wroom
    <li> Targett Module Clip w/Wrover
    <li> Thingz - Galaxia
    <li> TinyS2
    <li> nanoESP32-S2  w/Wrover
    <li> nanoESP32-S2 w/Wroom
    </ul>
    </details>
    </p>




.. py:class:: ParallelImageCapture(*, data_pins: List[microcontroller.Pin], clock: microcontroller.Pin, vsync: Optional[microcontroller.Pin], href: Optional[microcontroller.Pin])

   Capture image frames from a camera with parallel data interface

   Create a parallel image capture object

   :param List[microcontroller.Pin] data_pins: The data pins.
   :param microcontroller.Pin clock: The pixel clock input.
   :param microcontroller.Pin vsync: The vertical sync input, which has a negative-going pulse at the beginning of each frame.
   :param microcontroller.Pin href: The horizontal reference input, which is high whenever the camera is transmitting valid pixel information.

   .. py:method:: capture(buffer: _typing.WriteableBuffer) -> _typing.WriteableBuffer

      Capture a single frame into the given buffer.

      This will stop a continuous-mode capture, if one is in progress.


   .. py:method:: continuous_capture_start(buffer1: _typing.WriteableBuffer, buffer2: _typing.WriteableBuffer, /) -> None

      Begin capturing into the given buffers in the background.

      Call `continuous_capture_get_frame` to get the next available
      frame, and `continuous_capture_stop` to stop capturing.

      Until `continuous_capture_stop` (or `deinit`) is called, the
      `ParallelImageCapture` object keeps references to ``buffer1`` and
      ``buffer2``, so the objects will not be garbage collected.


   .. py:method:: continuous_capture_get_frame() -> _typing.WriteableBuffer

      Return the next available frame, one of the two buffers passed to `continuous_capture_start`


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

      Stop continuous capture.

      Calling this method also causes the object to release its
      references to the buffers passed to `continuous_capture_start`,
      potentially allowing the objects to be garbage collected.


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

      Deinitialize this instance


   .. py:method:: __enter__() -> ParallelImageCapture

      No-op used in Context Managers.


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

      Automatically deinitializes the hardware on context exit. See
      :ref:`lifetime-and-contextmanagers` for more info.