bitmaptools – Collection of bitmap manipulation tools

Note

If you’re looking for information about displaying bitmaps on screens in CircuitPython, see this Learn guide for information about using the displayio module.

Available on these boards
  • 01Space 0.42 OLED ESP32C3
  • 0xCB Helios
  • 42. Keebs Frood
  • AITHinker ESP32-C3S_Kit
  • AITHinker ESP32-C3S_Kit_2M
  • ARAMCON Badge 2019
  • ARAMCON2 Badge
  • ATMegaZero ESP32-S2
  • Adafruit CLUE nRF52840 Express
  • Adafruit Camera
  • Adafruit Circuit Playground Bluefruit
  • Adafruit EdgeBadge
  • Adafruit Feather Bluefruit Sense
  • Adafruit Feather ESP32 V2
  • Adafruit Feather ESP32-S2 Reverse TFT
  • Adafruit Feather ESP32-S2 TFT
  • Adafruit Feather ESP32-S3 Reverse TFT
  • Adafruit Feather ESP32-S3 TFT
  • Adafruit Feather ESP32S2
  • Adafruit Feather ESP32S3 4MB Flash 2MB PSRAM
  • Adafruit Feather ESP32S3 No PSRAM
  • Adafruit Feather HUZZAH32
  • Adafruit Feather M4 CAN
  • Adafruit Feather M4 Express
  • Adafruit Feather MIMXRT1011
  • Adafruit Feather RP2040
  • Adafruit Feather RP2040 CAN
  • Adafruit Feather RP2040 DVI
  • Adafruit Feather RP2040 Prop-Maker
  • Adafruit Feather RP2040 RFM
  • Adafruit Feather RP2040 Scorpio
  • Adafruit Feather RP2040 ThinkInk
  • Adafruit Feather RP2040 USB Host
  • Adafruit Feather STM32F405 Express
  • Adafruit Feather nRF52840 Express
  • Adafruit Floppsy RP2040
  • Adafruit FunHouse
  • Adafruit Grand Central M4 Express
  • Adafruit HUZZAH32 Breakout
  • Adafruit Hallowing M4 Express
  • Adafruit ItsyBitsy ESP32
  • Adafruit ItsyBitsy M4 Express
  • Adafruit ItsyBitsy RP2040
  • Adafruit ItsyBitsy nRF52840 Express
  • Adafruit KB2040
  • Adafruit LED Glasses Driver nRF52840
  • Adafruit Macropad RP2040
  • Adafruit MagTag
  • Adafruit Matrix Portal M4
  • Adafruit MatrixPortal S3
  • Adafruit Metro ESP32S2
  • Adafruit Metro ESP32S3
  • Adafruit Metro M4 Airlift Lite
  • Adafruit Metro M4 Express
  • Adafruit Metro RP2040
  • Adafruit Metro nRF52840 Express
  • Adafruit Monster M4SK
  • Adafruit PyGamer
  • Adafruit PyPortal
  • Adafruit PyPortal Pynt
  • Adafruit PyPortal Titano
  • Adafruit Pybadge
  • Adafruit QT Py ESP32 PICO
  • Adafruit QT Py ESP32-S3 4MB Flash 2MB PSRAM
  • Adafruit QT Py ESP32-S3 no psram
  • Adafruit QT Py ESP32C3
  • Adafruit QT Py ESP32S2
  • Adafruit QT Py RP2040
  • Adafruit QT2040 Trinkey
  • Adafruit Trellis M4 Express
  • Adafruit-Qualia-S3-RGB666
  • AloriumTech Evo M51
  • Arduino Nano 33 BLE
  • Arduino Nano ESP32
  • Arduino Nano RP2040 Connect
  • Artisense Reference Design RD00
  • AtelierDuMaker nRF52840 Breakout
  • BBQ20KBD
  • BDMICRO VINA-D51
  • BLE-SS dev board Multi Sensor
  • BLING!
  • BLOK
  • BPI-Bit-S2
  • BPI-Leaf-S3
  • BPI-PicoW-S3
  • BastBLE
  • BastWiFi
  • Bee-Data-Logger
  • Bee-Motion-S3
  • Bee-S3
  • BlizzardS3
  • BlueMicro840
  • COSMO-Pico
  • CP32-M4
  • CRCibernetica IdeaBoard
  • Challenger NB RP2040 WiFi
  • Challenger RP2040 LTE
  • Challenger RP2040 LoRa
  • Challenger RP2040 SD/RTC
  • Challenger RP2040 SubGHz
  • Challenger RP2040 WiFi
  • Challenger RP2040 WiFi/BLE
  • CircuitBrains Deluxe
  • ColumbiaDSL-Sensor-Board-V1
  • CrumpS2
  • Cytron EDU PICO W
  • Cytron Maker Feather AIoT S3
  • Cytron Maker Nano RP2040
  • Cytron Maker Pi RP2040
  • Cytron Maker Uno RP2040
  • DFRobot Beetle ESP32-C3
  • DFRobot FireBeetle 2 ESP32-S3
  • Datanoise PicoADK
  • Deneyap Kart
  • Deneyap Kart 1A
  • Deneyap Kart 1A v2
  • Deneyap Kart G
  • Deneyap Mini
  • Deneyap Mini v2
  • Diodes Delight Piunora
  • DynOSSAT-EDU-OBC
  • E-Fidget
  • ELECFREAKS PICO:ED
  • ES3ink
  • ESP 12k NodeMCU
  • ESP32 Devkit V1
  • ESP32-C3-DevKitM-1
  • ESP32-C6-DevKitC-1-N8
  • ESP32-C6-DevKitM-1
  • ESP32-H2-DevKitM-1
  • ESP32-S2-DevKitC-1-N4
  • ESP32-S2-DevKitC-1-N4R2
  • ESP32-S2-DevKitC-1-N8R2
  • ESP32-S3-Box-2.5
  • ESP32-S3-Box-Lite
  • ESP32-S3-DevKitC-1-N32R8
  • ESP32-S3-DevKitC-1-N8
  • ESP32-S3-DevKitC-1-N8R2
  • ESP32-S3-DevKitC-1-N8R8
  • ESP32-S3-DevKitC-1-N8R8-with-HACKTABLET
  • ESP32-S3-DevKitM-1-N8
  • ESP32-S3-EYE
  • ESP32-S3-USB-OTG-N8
  • Electrolama minik
  • Electronut Labs Blip
  • Electronut Labs Papyr
  • EncoderPad RP2040
  • Espressif ESP32 DevKitc V4 WROOM-32E
  • Espressif ESP32 DevKitc V4 WROVER
  • Espressif ESP32-EYE
  • Espressif ESP32-LyraT
  • Espressif-ESP32-S3-LCD-EV-Board
  • Espruino Bangle.js 2
  • Espruino Wifi
  • Feather MIMXRT1011
  • Feather MIMXRT1062
  • FeatherS2
  • FeatherS2 Neo
  • FeatherS2 PreRelease
  • FeatherS3
  • Fig Pi
  • Flipper Zero Wi-Fi Dev
  • Franzininho WIFI w/Wroom
  • Franzininho WIFI w/Wrover
  • Gravitech Cucumber M
  • Gravitech Cucumber MS
  • Gravitech Cucumber R
  • Gravitech Cucumber RS
  • HEIA-FR Picomo V2
  • HMI-DevKit-1.1
  • Hack Club Sprig
  • Hardkernel Odroid Go
  • Heltec ESP32-S3-WIFI-LoRa-V3
  • HexKyS2
  • HiiBot BlueFi
  • IMXRT1010-EVK
  • IMXRT1015-EVK
  • IkigaiSense Vita nRF52840
  • IoTs2
  • Kaluga 1
  • LILYGO T-DECK
  • LILYGO T-DISPLAY
  • LILYGO T-DISPLAY S3 v1.2
  • LILYGO TEMBED ESP32S3
  • LILYGO TTGO T-01C3
  • LILYGO TTGO T-DISPLAY v1.1
  • LILYGO TTGO T-DISPLAY v1.1 4M
  • LILYGO TTGO T-OI PLUS
  • LILYGO TTGO T8 ESP32-S2
  • LILYGO TTGO T8 ESP32-S2 w/Display
  • LOLIN S3 16MB Flash 8MB PSRAM
  • LOLIN S3 MINI 4MB Flash 2MB PSRAM
  • Lilygo T-watch 2020 V3
  • Luatos Core-ESP32C3
  • M5STACK STAMP-C3
  • M5Stack Atom Echo
  • M5Stack Atom Lite
  • M5Stack Atom Matrix
  • M5Stack Atom U
  • M5Stack AtomS3
  • M5Stack AtomS3 Lite
  • M5Stack AtomS3U
  • M5Stack Core Basic
  • M5Stack Core Fire
  • M5Stack Core2
  • M5Stack Dial
  • M5Stack M5Paper
  • M5Stack Stick C
  • M5Stack Stick C Plus
  • M5Stack Timer Camera X
  • MDBT50Q-DB-40
  • MDBT50Q-RX Dongle
  • MORPHEANS MorphESP-240
  • MagiClick S3 N4R2
  • Maker badge by Czech maker
  • MakerDiary nRF52840 MDK
  • MakerDiary nRF52840 MDK USB Dongle
  • MakerFabs-ESP32-S3-Parallel-TFT-With-Touch-7inch
  • Makerdiary M60 Keyboard
  • Makerdiary Pitaya Go
  • Makerdiary nRF52840 Connect Kit
  • Makerdiary nRF52840 M.2 Developer Kit
  • Maple Computing Elite-Pi
  • Melopero Shake RP2040
  • Metro MIMXRT1011
  • MicroDev microC3
  • MicroDev microS2
  • Mini SAM M4
  • MixGo CE
  • NUCLEO STM32F746
  • NUCLEO STM32F767
  • NUCLEO STM32H743
  • NanoS3
  • Neuron
  • OPENMV-H7 R1
  • Oak Dev Tech BREAD2040
  • Oak Dev Tech Cast-Away RP2040
  • Oak Dev Tech PixelWing ESP32S2
  • Open Hardware Summit 2020 Badge
  • Oxocard Artwork
  • Oxocard Connect
  • Oxocard Galaxy
  • Oxocard Science
  • P1AM-200
  • PCA10056 nRF52840-DK
  • PCA10059 nRF52840 Dongle
  • PYB LR Nano V2
  • Pajenicko PicoPad
  • Particle Argon
  • Particle Boron
  • Particle Xenon
  • PillBug
  • Pimoroni Badger 2040
  • Pimoroni Badger 2040 W
  • Pimoroni Inky Frame 5.7
  • Pimoroni Inky Frame 7.3
  • Pimoroni Interstate 75
  • Pimoroni Keybow 2040
  • Pimoroni Motor 2040
  • Pimoroni PGA2040
  • Pimoroni Pico DV Base W
  • Pimoroni Pico LiPo (16MB)
  • Pimoroni Pico LiPo (4MB)
  • Pimoroni Pico dv Base
  • Pimoroni PicoSystem
  • Pimoroni Plasma 2040
  • Pimoroni Plasma 2040W
  • Pimoroni Servo 2040
  • Pimoroni Tiny 2040 (2MB)
  • Pimoroni Tiny 2040 (8MB)
  • ProS3
  • PyKey 18 Numpad
  • PyKey 44 Ergo
  • PyKey 60
  • PyKey 87 TKL
  • PyboardV1_1
  • RP2.65-F
  • RP2040 Stamp
  • Raspberry Breadstick
  • Raspberry Pi 4B
  • Raspberry Pi Compute Module 4
  • Raspberry Pi Compute Module 4 IO Board
  • Raspberry Pi Pico
  • Raspberry Pi Pico W
  • Raspberry Pi Zero
  • Raspberry Pi Zero 2W
  • Raspberry Pi Zero W
  • S2Mini
  • S2Pico
  • SAM E54 Xplained Pro
  • SAM32v26
  • SSCI ISP1807 Dev Board
  • SSCI ISP1807 Micro Board
  • ST STM32F746G Discovery
  • STM32F412G_DISCO
  • STM32F4_DISCO
  • Saola 1 w/Wroom
  • Saola 1 w/Wrover
  • Seeed Studio XIAO ESP32C3
  • Seeed XIAO nRF52840 Sense
  • Seeeduino Wio Terminal
  • Seeeduino XIAO RP2040
  • SiLabs xG24 Dev Kit
  • SiLabs xG24 Explorer Kit
  • Silicognition LLC M4-Shim
  • Silicognition LLC RP2040-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 Teensy MicroMod Processor
  • SparkFun Thing Plus - RP2040
  • SparkFun Thing Plus - SAMD51
  • SparkFun Thing Plus - STM32
  • Sparkfun Thing Plus MGM240P
  • SuperMini NRF52840
  • Swan R5
  • TG-Boards' Datalore IP M4
  • TG-Watch
  • TTGO T8 ESP32-S2-WROOM
  • 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
  • TinyC6
  • TinyPICO
  • TinyPICO Nano
  • TinyS2
  • TinyS3
  • TinyWATCH S3
  • UARTLogger II
  • VCC-GND Studio YD RP2040
  • VCC-GND YD-ESP32-S3 (N16R8)
  • VCC-GND YD-ESP32-S3 (N8R8)
  • W5100S-EVB-Pico
  • W5500-EVB-Pico
  • WSC-1450
  • WarmBit BluePixel nRF52840
  • Waveshare ESP32-S2-Pico
  • Waveshare ESP32-S2-Pico-LCD
  • Waveshare ESP32-S3-Pico
  • Waveshare ESP32-S3-Zero
  • Waveshare RP2040-LCD-0.96
  • Waveshare RP2040-LCD-1.28
  • Waveshare RP2040-Plus (16MB)
  • Waveshare RP2040-Plus (4MB)
  • Waveshare RP2040-TOUCH-LCD-1.28
  • Waveshare RP2040-Zero
  • WeAct ESP32-C6 (4MB)
  • WeAct ESP32-C6 (8MB)
  • WeAct Studio Pico
  • WeAct Studio Pico 16MB
  • Wemos Lolin C3 Mini" // from Wemos MP
  • Wemos Lolin C3 Pico" // from Wemos MP
  • WisdPi Ardu2040M
  • WisdPi Tiny RP2040
  • iLabs Challenger 840
  • iMX RT 1020 EVK
  • iMX RT 1040 EVK
  • iMX RT 1050 EVKB
  • iMX RT 1060 EVK
  • iMX RT 1060 EVKB
  • nanoESP32-S2 w/Wrover
  • nanoESP32-S2 w/Wroom
  • nice!nano
  • nullbits Bit-C PRO
  • senseBox MCU-S2 ESP32S2
  • splitkb.com Liatris
  • stm32f411ce-blackpill
  • stm32f411ce-blackpill-with-flash
  • takayoshiotake Octave RP2040
  • uGame22

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. Defaults to None which causes it to use the horizontal midway point of the destination bitmap.

  • oy (int) – Vertical pixel location in destination bitmap where source bitmap point (px,py) is placed. Defaults to None which causes it to use the vertical midway point of the destination bitmap.

  • 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). Defaults to None which causes it to use the horizontal midway point in the source bitmap.

  • py (int) – Vertical pixel location in source bitmap that is placed into the destination bitmap at (ox,oy). Defaults to None which causes it to use the vertical midway point in the source bitmap.

  • 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). Defaults to None which gets treated as 0.0 radians or no rotation.

  • scale (float) – Scaling factor. Defaults to None which gets treated as 1.0 or same as original source size.

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

class bitmaptools.BlendMode

The blend mode for alphablend to operate use

Normal: BlendMode

Blend with equal parts of the two source bitmaps

Screen: BlendMode

Blend based on the value in each color channel. The result keeps the lighter colors and discards darker colors.

bitmaptools.alphablend(dest_bitmap: displayio.Bitmap, source_bitmap_1: displayio.Bitmap, source_bitmap_2: displayio.Bitmap, colorspace: displayio.Colorspace, factor1: float = 0.5, factor2: float | None = None, blendmode: BlendMode | None = BlendMode.Normal, skip_source1_index: int | None = None, skip_source2_index: int | None = None) None

Alpha blend the two source bitmaps into the destination.

It is permitted for the destination bitmap to be one of the two source bitmaps.

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

  • source_bitmap_1 (bitmap) – The first source bitmap

  • source_bitmap_2 (bitmap) – The second source bitmap

  • factor1 (float) – The proportion of bitmap 1 to mix in

  • factor2 (float) – The proportion of bitmap 2 to mix in. If specified as None, 1-factor1 is used. Usually the proportions should sum to 1.

  • colorspace (displayio.Colorspace) – The colorspace of the bitmaps. They must all have the same colorspace. Only the following colorspaces are permitted: L8, RGB565, RGB565_SWAPPED, BGR565 and BGR565_SWAPPED.

  • blendmode (bitmaptools.BlendMode) – The blend mode to use. Default is Normal.

  • skip_source1_index (int) – Bitmap palette or luminance index in source_bitmap_1 that will not be blended, set to None to blend all pixels

  • skip_source2_index (int) – Bitmap palette or luminance index in source_bitmap_2 that will not be blended, set to None to blend all pixels

For the L8 colorspace, the bitmaps must have a bits-per-value of 8. For the RGB colorspaces, they must have a bits-per-value of 16.

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.draw_polygon(dest_bitmap: displayio.Bitmap, xs: circuitpython_typing.ReadableBuffer, ys: circuitpython_typing.ReadableBuffer, value: int, close: bool | None = True) None

Draw a polygon connecting points on provided bitmap with provided value

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

  • xs (ReadableBuffer) – x-pixel position of the polygon’s vertices

  • ys (ReadableBuffer) – y-pixel position of the polygon’s vertices

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

  • close (bool) – (Optional) Whether to connect first and last point. (True)

import board
import displayio
import bitmaptools

display = board.DISPLAY
main_group = displayio.Group()
display.root_group = main_group

palette = displayio.Palette(3)
palette[0] = 0xffffff
palette[1] = 0x0000ff
palette[2] = 0xff0000

bmp = displayio.Bitmap(128,128, 3)
bmp.fill(0)

xs = bytes([4, 101, 101, 19])
ys = bytes([4, 19,  121, 101])
bitmaptools.draw_polygon(bmp, xs, ys, 1)

xs = bytes([14, 60, 110])
ys = bytes([14, 24,  90])
bitmaptools.draw_polygon(bmp, xs, ys, 2)

tilegrid = displayio.TileGrid(bitmap=bmp, pixel_shader=palette)
main_group.append(tilegrid)

while True:
    pass
bitmaptools.arrayblit(bitmap: displayio.Bitmap, data: circuitpython_typing.ReadableBuffer, x1: int = 0, y1: int = 0, x2: int | None = None, y2: int | None = None, skip_index: int | None = 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 available 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 (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 Significant 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).

class bitmaptools.DitherAlgorithm

Identifies the algorithm for dither to use

Atkinson: DitherAlgorithm

The classic Atkinson dither, often associated with the Hypercard esthetic

FloydStenberg: DitherAlgorithm

The Floyd-Stenberg dither

bitmaptools.dither(dest_bitmap: displayio.Bitmap, source_bitmapp: displayio.Bitmap, source_colorspace: displayio.Colorspace, algorithm: DitherAlgorithm = DitherAlgorithm.Atkinson) None

Convert the input image into a 2-level output image using the given dither algorithm.

Parameters:
  • dest_bitmap (bitmap) – Destination bitmap. It must have a value_count of 2 or 65536. The stored values are 0 and the maximum pixel value.

  • source_bitmap (bitmap) – Source bitmap that contains the graphical region to be dithered. It must have a value_count of 65536.

  • colorspace – The colorspace of the image. The supported colorspaces are RGB565, BGR565, RGB565_SWAPPED, and BGR565_SWAPPED

  • algorithm – The dither algorithm to use, one of the DitherAlgorithm values.

bitmaptools.draw_circle(dest_bitmap: displayio.Bitmap, x: int, y: int, radius: int, value: int) None

Draws a circle into a bitmap specified using a center (x0,y0) and radius r.

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

  • x (int) – x-pixel position of the circle’s center

  • y (int) – y-pixel position of the circle’s center

  • radius (int) – circle’s radius

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

import board
import displayio
import bitmaptools

display = board.DISPLAY
main_group = displayio.Group()
display.root_group = main_group

palette = displayio.Palette(2)
palette[0] = 0xffffff
palette[1] = 0x440044

bmp = displayio.Bitmap(128,128, 2)
bmp.fill(0)

bitmaptools.circle(64,64, 32, 1)

tilegrid = displayio.TileGrid(bitmap=bmp, pixel_shader=palette)
main_group.append(tilegrid)

while True:
    pass
bitmaptools.blit(dest_bitmap: displayio.Bitmap, source_bitmap: displayio.Bitmap, x: int, y: int, *, x1: int = 0, y1: int = 0, x2: int | None = None, y2: int | None = None, skip_source_index: int | None = None, skip_dest_index: int | None = None) None

Inserts the source_bitmap region defined by rectangular boundaries (x1,y1) and (x2,y2) into the bitmap at the specified (x,y) location.

Parameters:
  • dest_bitmap (bitmap) – Destination bitmap that the area will be copied into.

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

  • x (int) – Horizontal pixel location in bitmap where source_bitmap upper-left corner will be placed

  • y (int) – Vertical pixel location in bitmap where source_bitmap upper-left corner will be placed

  • x1 (int) – Minimum x-value for rectangular bounding box to be copied from the source bitmap

  • y1 (int) – Minimum y-value for rectangular bounding box to be copied from the source bitmap

  • x2 (int) – Maximum x-value (exclusive) for rectangular bounding box to be copied from the source bitmap. If unspecified or None, the source bitmap width is used.

  • y2 (int) – Maximum y-value (exclusive) for rectangular bounding box to be copied from the source bitmap. If unspecified or None, the source bitmap height is used.

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

  • skip_dest_index (int) – bitmap palette index in the destination bitmap that will not get overwritten by the pixels from the source