image

Note

This module is only applicable to the CoreS3 Controller

Micropython Example

draw test

# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT
import os, sys, io
import M5
from M5 import *
import camera
import image

img = None


def setup():
    global img
    M5.begin()
    Widgets.fillScreen(0x222222)
    camera.init(pixformat=camera.RGB565, framesize=camera.QVGA)


def loop():
    global img
    M5.update()
    img = camera.snapshot()
    img.draw_string(10, 10, str("M5Stack"), color=0x3366FF, scale=2)
    img.draw_rectangle(60, 80, 50, 40, color=0x33CC00, thickness=3, fill=False)
    img.draw_line(200, 60, 260, 100, color=0xFF0000, thickness=3)
    img.draw_circle(160, 120, 30, color=0xFFCC00, thickness=2, fill=False)
    M5.Lcd.show(img, 0, 0, 320, 240)


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

UIFlow2.0 Example

draw test

cores3_example_draw_test.m5f2

class image.Image

The line object is returned by camera.snapshot().

Basic Methods

image.width() → int

Returns the image width in pixels.

UIFlow2.0

image.height() → int

Returns the image height in pixels.

UIFlow2.0

image.format() → int

Returns the image format

UIFlow2.0

image.size() → int

Returns the image size in bytes.

UIFlow2.0

image.bytearray() → bytearray

Returns a bytearray object that points to the image data for byte-level read/write access.

UIFlow2.0

Drawing Methods

image.draw_line(x0: int, y0: int, x1: int, y1: int, color: int | Tuple[int, int, int] | None = None, thickness=1) → Image

Draws a line from (x0, y0) to (x1, y1) on the image. You may either pass x0, y0, x1, y1 separately or as a tuple (x0, y0, x1, y1).

color is an RGB888 tuple for Grayscale or RGB565 images. Defaults to white. However, you may also pass the underlying pixel value (0-255) for grayscale images or a RGB565 value for RGB565 images.
thickness controls how thick the line is in pixels.

Returns the image object so you can call another method using . notation.

UIFlow2.0

image.draw_rectangle(x: int, y: int, w: int, h: int, color: int | Tuple[int, int, int] | None = None, thickness=1, fill=False) → Image

Draws a rectangle on the image. You may either pass x, y, w, h separately or as a tuple (x, y, w, h).

color is an RGB888 tuple for Grayscale or RGB565 images. Defaults to white. However, you may also pass the underlying pixel value (0-255) for grayscale images or a RGB565 value for RGB565 images.
thickness controls how thick the lines are in pixels.
fill set to True to fill the rectangle.

Returns the image object so you can call another method using . notation.

UIFlow2.0

image.draw_circle(x: int, y: int, radius: int, color: int | Tuple[int, int, int] | None = None, thickness=1, fill=False) → Image

Draws a circle on the image. You may either pass x, y, radius separately or as a tuple (x, y, radius).

color is an RGB888 tuple for Grayscale or RGB565 images. Defaults to white. However, you may also pass the underlying pixel value (0-255) for grayscale images or a RGB565 value for RGB565 images.
thickness controls how thick the edges are in pixels.
fill set to True to fill the circle.

Returns the image object so you can call another method using . notation.

UIFlow2.0

image.draw_string(x: int, y: int, text: str, color: int | Tuple[int, int, int] | None = None, scale=1) → Image

Draws 8x16 text starting at location (x, y) in the image. You may either pass x, y separately or as a tuple (x, y).

text is a string to write to the image. \n, \r, and \r\n line endings move the cursor to the next line.
color is an RGB888 tuple for Grayscale or RGB565 images. Defaults to white. However, you may also pass the underlying pixel value (0-255) for grayscale images or a RGB565 value for RGB565 images.
scale may be increased to increase/decrease the size of the text on the image. You can pass greater than 0 integer or floating point values.

Returns the image object so you can call another method using . notation.

UIFlow2.0

Constants

image.RGB565: int: RGB565 pixel format. Each pixel is 16-bits, 2-bytes. 5-bits are used for red, 6-bits are used for green, and 5-bits are used for blue.

image.GRAYSCALE: int: GRAYSCALE pixel format. Each pixel is 8-bits, 1-byte.

image.JPEG: int: A JPEG image.

image.YUV422: int: A pixel format that is very easy to jpeg compress. Each pixel is stored as a grayscale 8-bit Y value followed by alternating 8-bit U/V color values that are shared between two Y values (8-bits Y1, 8-bits U, 8-bits Y2, 8-bits V, etc.). Only some image processing methods work with YUV422.

UIFlow2.0