bitmaptools – Collection of bitmap manipulation tools

Available on these boards
  • ARAMCON Badge 2019
  • ARAMCON2 Badge
  • ATMegaZero ESP32-S2
  • Adafruit CLUE nRF52840 Express
  • Adafruit Circuit Playground Bluefruit
  • Adafruit EdgeBadge
  • Adafruit Feather Bluefruit Sense
  • Adafruit Feather M4 CAN
  • Adafruit Feather M4 Express
  • Adafruit Feather MIMXRT1011
  • Adafruit Feather RP2040
  • Adafruit Feather STM32F405 Express
  • Adafruit Feather nRF52840 Express
  • Adafruit FunHouse
  • Adafruit Grand Central M4 Express
  • Adafruit Hallowing M4 Express
  • Adafruit ItsyBitsy M4 Express
  • Adafruit ItsyBitsy RP2040
  • Adafruit ItsyBitsy nRF52840 Express
  • Adafruit LED Glasses Driver nRF52840
  • Adafruit Macropad RP2040
  • Adafruit MagTag
  • Adafruit Matrix Portal M4
  • Adafruit Metro ESP32S2
  • Adafruit Metro M4 Airlift Lite
  • Adafruit Metro M4 Express
  • Adafruit Metro nRF52840 Express
  • Adafruit Monster M4SK
  • Adafruit PyGamer
  • Adafruit PyPortal
  • Adafruit PyPortal Pynt
  • Adafruit PyPortal Titano
  • Adafruit Pybadge
  • Adafruit QT Py RP2040
  • Adafruit QT2040 Trinkey
  • Adafruit Trellis M4 Express
  • AloriumTech Evo M51
  • Arduino Nano 33 BLE
  • Arduino Nano RP2040 Connect
  • Artisense Reference Design RD00
  • AtelierDuMaker nRF52840 Breakout
  • BDMICRO VINA-D51
  • BLE-SS dev board Multi Sensor
  • BastBLE
  • BastWiFi
  • BlueMicro840
  • CP32-M4
  • Capable Robot Programmable USB Hub
  • Challenger RP2040 WiFi
  • CircuitBrains Deluxe
  • CrumpS2
  • Cytron Maker Pi RP2040
  • DynOSSAT-EDU-OBC
  • ESP 12k NodeMCU
  • Electronut Labs Blip
  • Electronut Labs Papyr
  • EncoderPad RP2040
  • Espruino Wifi
  • Feather ESP32S2 without PSRAM
  • Feather MIMXRT1011
  • Feather MIMXRT1062
  • FeatherS2
  • FeatherS2 Neo
  • FeatherS2 PreRelease
  • Franzininho WIFI w/Wroom
  • Franzininho WIFI w/Wrover
  • Gravitech Cucumber M
  • Gravitech Cucumber MS
  • Gravitech Cucumber R
  • Gravitech Cucumber RS
  • HMI-DevKit-1.1
  • HiiBot BlueFi
  • IMXRT1010-EVK
  • IkigaiSense Vita nRF52840
  • Kaluga 1
  • LILYGO TTGO T8 ESP32-S2 w/Display
  • MDBT50Q-DB-40
  • MDBT50Q-RX Dongle
  • MEOWBIT
  • MORPHEANS MorphESP-240
  • MakerDiary nRF52840 MDK
  • MakerDiary nRF52840 MDK USB Dongle
  • Makerdiary M60 Keyboard
  • Makerdiary Pitaya Go
  • Makerdiary nRF52840 M.2 Developer Kit
  • Melopero Shake RP2040
  • Metro MIMXRT1011
  • Mini SAM M4
  • NUCLEO STM32F746
  • NUCLEO STM32F767
  • NUCLEO STM32H743
  • OPENMV-H7 R1
  • Oak Dev Tech BREAD2040
  • Oak Dev Tech PixelWing ESP32S2
  • Open Hardware Summit 2020 Badge
  • PCA10056 nRF52840-DK
  • PCA10059 nRF52840 Dongle
  • Particle Argon
  • Particle Boron
  • Particle Xenon
  • Pimoroni Interstate 75
  • Pimoroni Keybow 2040
  • Pimoroni PGA2040
  • Pimoroni Pico LiPo (16MB)
  • Pimoroni Pico LiPo (4MB)
  • Pimoroni PicoSystem
  • Pimoroni Plasma 2040
  • Pimoroni Tiny 2040
  • PyKey60
  • PyboardV1_1
  • Raspberry Pi Pico
  • S2Mini
  • SAM E54 Xplained Pro
  • SAM32v26
  • ST STM32F746G Discovery
  • STM32F412G_DISCO
  • STM32F4_DISCO
  • Saola 1 w/Wroom
  • Saola 1 w/Wrover
  • Seeeduino Wio Terminal
  • Silicognition LLC M4-Shim
  • SparkFun MicroMod RP2040 Processor
  • SparkFun MicroMod SAMD51 Processor
  • SparkFun MicroMod nRF52840 Processor
  • SparkFun Pro Micro RP2040
  • SparkFun Pro nRF52840 Mini
  • SparkFun STM32 MicroMod Processor
  • SparkFun Thing Plus - RP2040
  • SparkFun Thing Plus - SAMD51
  • TG-Boards' Datalore IP M4
  • TG-Watch
  • THUNDERPACK_v11
  • THUNDERPACK_v12
  • Targett Module Clip w/Wroom
  • Targett Module Clip w/Wrover
  • Teensy 4.0
  • Teensy 4.1
  • Teknikio Bluebird
  • The Open Book Feather
  • TinkeringTech ScoutMakes Azul
  • TinyS2
  • UARTLogger II
  • WarmBit BluePixel nRF52840
  • iMX RT 1020 EVK
  • iMX RT 1060 EVK
  • microS2
  • nanoESP32-S2 w/Wrover
  • nanoESP32-S2 w/Wroom
  • nice!nano
  • stm32f411ce-blackpill
  • stm32f411ce-blackpill-with-flash

bitmaptools.rotozoom(dest_bitmap: displayio.Bitmap, source_bitmap: displayio.Bitmap, *, ox: int, oy: int, dest_clip0: Tuple[int, int], dest_clip1: Tuple[int, int], px: int, py: int, source_clip0: Tuple[int, int], source_clip1: Tuple[int, int], angle: float, scale: float, skip_index: int)None

Inserts the source bitmap region into the destination bitmap with rotation (angle), scale and clipping (both on source and destination bitmaps).

Parameters
  • dest_bitmap (bitmap) – Destination bitmap that will be copied into

  • source_bitmap (bitmap) – Source bitmap that contains the graphical region to be copied

  • ox (int) – Horizontal pixel location in destination bitmap where source bitmap point (px,py) is placed

  • oy (int) – Vertical pixel location in destination bitmap where source bitmap point (px,py) is placed

  • dest_clip0 (Tuple[int,int]) – First corner of rectangular destination clipping region that constrains region of writing into destination bitmap

  • dest_clip1 (Tuple[int,int]) – Second corner of rectangular destination clipping region that constrains region of writing into destination bitmap

  • px (int) – Horizontal pixel location in source bitmap that is placed into the destination bitmap at (ox,oy)

  • py (int) – Vertical pixel location in source bitmap that is placed into the destination bitmap at (ox,oy)

  • source_clip0 (Tuple[int,int]) – First corner of rectangular source clipping region that constrains region of reading from the source bitmap

  • source_clip1 (Tuple[int,int]) – Second corner of rectangular source clipping region that constrains region of reading from the source bitmap

  • angle (float) – Angle of rotation, in radians (positive is clockwise direction)

  • scale (float) – Scaling factor

  • skip_index (int) – Bitmap palette index in the source that will not be copied, set to None to copy all pixels

bitmaptools.fill_region(dest_bitmap: displayio.Bitmap, x1: int, y1: int, x2: int, y2: int, value: int)None

Draws the color value into the destination bitmap within the rectangular region bounded by (x1,y1) and (x2,y2), exclusive.

Parameters
  • dest_bitmap (bitmap) – Destination bitmap that will be written into

  • x1 (int) – x-pixel position of the first corner of the rectangular fill region

  • y1 (int) – y-pixel position of the first corner of the rectangular fill region

  • x2 (int) – x-pixel position of the second corner of the rectangular fill region (exclusive)

  • y2 (int) – y-pixel position of the second corner of the rectangular fill region (exclusive)

  • value (int) – Bitmap palette index that will be written into the rectangular fill region in the destination bitmap

bitmaptools.boundary_fill(dest_bitmap: displayio.Bitmap, x: int, y: int, fill_color_value: int, replaced_color_value: int)None

Draws the color value into the destination bitmap enclosed area of pixels of the background_value color. Like “Paint Bucket” fill tool.

Parameters
  • dest_bitmap (bitmap) – Destination bitmap that will be written into

  • x (int) – x-pixel position of the first pixel to check and fill if needed

  • y (int) – y-pixel position of the first pixel to check and fill if needed

  • fill_color_value (int) – Bitmap palette index that will be written into the enclosed area in the destination bitmap

  • replaced_color_value (int) – Bitmap palette index that will filled with the value color in the enclosed area in the destination bitmap

bitmaptools.draw_line(dest_bitmap: displayio.Bitmap, x1: int, y1: int, x2: int, y2: int, value: int)None

Draws a line into a bitmap specified two endpoints (x1,y1) and (x2,y2).

Parameters
  • dest_bitmap (bitmap) – Destination bitmap that will be written into

  • x1 (int) – x-pixel position of the line’s first endpoint

  • y1 (int) – y-pixel position of the line’s first endpoint

  • x2 (int) – x-pixel position of the line’s second endpoint

  • y2 (int) – y-pixel position of the line’s second endpoint

  • value (int) – Bitmap palette index that will be written into the line in the destination bitmap

bitmaptools.arrayblit(bitmap: displayio.Bitmap, data: _typing.ReadableBuffer, x1: int = 0, y1: int = 0, x2: Optional[int] = None, y2: Optional[int] = None, skip_index: Optional[int] = None)None

Inserts pixels from data into the rectangle of width×height pixels with the upper left corner at (x,y)

The values from data are taken modulo the number of color values avalable in the destination bitmap.

If x1 or y1 are not specified, they are taken as 0. If x2 or y2 are not specified, or are given as -1, they are taken as the width and height of the image.

The coordinates affected by the blit are x1 <= x < x2 and y1 <= y < y2.

data must contain at least as many elements as required. If it contains excess elements, they are ignored.

The blit takes place by rows, so the first elements of data go to the first row, the next elements to the next row, and so on.

Parameters
  • bitmap (displayio.Bitmap) – A writable bitmap

  • data (ReadableBuffer) – Buffer containing the source pixel values

  • x1 (int) – The left corner of the area to blit into (inclusive)

  • y1 (int) – The top corner of the area to blit into (inclusive)

  • x2 (int) – The right of the area to blit into (exclusive)

  • y2 (int) – The bottom corner of the area to blit into (exclusive)

  • skip_index (int) – Bitmap palette index in the source that will not be copied, set to None to copy all pixels

bitmaptools.readinto(bitmap: displayio.Bitmap, file: BinaryIO, bits_per_pixel: int, element_size: int = 1, reverse_pixels_in_element: bool = False, swap_bytes_in_element: bool = False, reverse_rows: bool = False)None

Reads from a binary file into a bitmap.

The file must be positioned so that it consists of bitmap.height rows of pixel data, where each row is the smallest multiple of element_size bytes that can hold bitmap.width pixels.

The bytes in an element can be optionally swapped, and the pixels in an element can be reversed. Also, the row loading direction can be reversed, which may be requires for loading certain bitmap files.

This function doesn’t parse image headers, but is useful to speed up loading of uncompressed image formats such as PCF glyph data.

Parameters
  • bitmap (displayio.Bitmap) – A writable bitmap

  • file (typing.BinaryIO) – A file opened in binary mode

  • bits_per_pixel (int) – Number of bits per pixel. Values 1, 2, 4, 8, 16, 24, and 32 are supported;

  • element_size (int) – Number of bytes per element. Values of 1, 2, and 4 are supported, except that 24 bits_per_pixel requires 1 byte per element.

  • reverse_pixels_in_element (bool) – If set, the first pixel in a word is taken from the Most Signficant Bits; otherwise, it is taken from the Least Significant Bits.

  • swap_bytes_in_element (bool) – If the element_size is not 1, then reverse the byte order of each element read.

  • reverse_rows (bool) – Reverse the direction of the row loading (required for some bitmap images).