text: // SPDX-FileCopyrightText: 2014 MicroPython & CircuitPython contributors (https://github.com/adafruit/circuitpython/graphs/contributors)
  // SPDX-FileCopyrightText: Copyright (c) 2016 Damien P. George
  //
  // SPDX-License-Identifier: MIT
  
  #include <stdio.h>
  #include <string.h>
  
  #include "py/runtime.h"
  #include "py/objtype.h"
  #include "py/proto.h"
  
  #if MICROPY_PY_FRAMEBUF
  
  #include "font_petme128_8x8.h"
  
  typedef struct _mp_obj_framebuf_t {
      mp_obj_base_t base;
      mp_obj_t buf_obj; // need to store this to prevent GC from reclaiming buf
      void *buf;
      uint16_t width, height, stride;
      uint8_t format;
  } mp_obj_framebuf_t;
  
  typedef void (*setpixel_t)(const mp_obj_framebuf_t *, int, int, uint32_t);
  typedef uint32_t (*getpixel_t)(const mp_obj_framebuf_t *, int, int);
  typedef void (*fill_rect_t)(const mp_obj_framebuf_t *, int, int, int, int, uint32_t);
  
  typedef struct _mp_framebuf_p_t {
      MP_PROTOCOL_HEAD
      setpixel_t setpixel;
      getpixel_t getpixel;
      fill_rect_t fill_rect;
  } mp_framebuf_p_t;
  
  // constants for formats
  #define FRAMEBUF_MVLSB    (0)
  #define FRAMEBUF_RGB565   (1)
  #define FRAMEBUF_GS2_HMSB (5)
  #define FRAMEBUF_GS4_HMSB (2)
  #define FRAMEBUF_GS8      (6)
  #define FRAMEBUF_MHLSB    (3)
  #define FRAMEBUF_MHMSB    (4)
  
  // Functions for MHLSB and MHMSB
  
  STATIC void mono_horiz_setpixel(const mp_obj_framebuf_t *fb, int x, int y, uint32_t col) {
      size_t index = (x + y * fb->stride) >> 3;
      int offset = fb->format == FRAMEBUF_MHMSB ? x & 0x07 : 7 - (x & 0x07);
      ((uint8_t *)fb->buf)[index] = (((uint8_t *)fb->buf)[index] & ~(0x01 << offset)) | ((col != 0) << offset);
  }
  
  STATIC uint32_t mono_horiz_getpixel(const mp_obj_framebuf_t *fb, int x, int y) {
      size_t index = (x + y * fb->stride) >> 3;
      int offset = fb->format == FRAMEBUF_MHMSB ? x & 0x07 : 7 - (x & 0x07);
      return (((uint8_t *)fb->buf)[index] >> (offset)) & 0x01;
  }
  
  STATIC void mono_horiz_fill_rect(const mp_obj_framebuf_t *fb, int x, int y, int w, int h, uint32_t col) {
      int reverse = fb->format == FRAMEBUF_MHMSB;
      int advance = fb->stride >> 3;
      while (w--) {
          uint8_t *b = &((uint8_t *)fb->buf)[(x >> 3) + y * advance];
          int offset = reverse ?  x & 7 : 7 - (x & 7);
          for (int hh = h; hh; --hh) {
              *b = (*b & ~(0x01 << offset)) | ((col != 0) << offset);
              b += advance;
          }
          ++x;
      }
  }
  
  // Functions for MVLSB format
  
  STATIC void mvlsb_setpixel(const mp_obj_framebuf_t *fb, int x, int y, uint32_t col) {
      size_t index = (y >> 3) * fb->stride + x;
      uint8_t offset = y & 0x07;
      ((uint8_t *)fb->buf)[index] = (((uint8_t *)fb->buf)[index] & ~(0x01 << offset)) | ((col != 0) << offset);
  }
  
  STATIC uint32_t mvlsb_getpixel(const mp_obj_framebuf_t *fb, int x, int y) {
      return (((uint8_t *)fb->buf)[(y >> 3) * fb->stride + x] >> (y & 0x07)) & 0x01;
  }
  
  STATIC void mvlsb_fill_rect(const mp_obj_framebuf_t *fb, int x, int y, int w, int h, uint32_t col) {
      while (h--) {
          uint8_t *b = &((uint8_t *)fb->buf)[(y >> 3) * fb->stride + x];
          uint8_t offset = y & 0x07;
          for (int ww = w; ww; --ww) {
              *b = (*b & ~(0x01 << offset)) | ((col != 0) << offset);
              ++b;
          }
          ++y;
      }
  }
  
  // Functions for RGB565 format
  
  STATIC void rgb565_setpixel(const mp_obj_framebuf_t *fb, int x, int y, uint32_t col) {
      ((uint16_t *)fb->buf)[x + y * fb->stride] = col;
  }
  
  STATIC uint32_t rgb565_getpixel(const mp_obj_framebuf_t *fb, int x, int y) {
      return ((uint16_t *)fb->buf)[x + y * fb->stride];
  }
  
  STATIC void rgb565_fill_rect(const mp_obj_framebuf_t *fb, int x, int y, int w, int h, uint32_t col) {
      uint16_t *b = &((uint16_t *)fb->buf)[x + y * fb->stride];
      while (h--) {
          for (int ww = w; ww; --ww) {
              *b++ = col;
          }
          b += fb->stride - w;
      }
  }
  
  // Functions for GS2_HMSB format
  
  STATIC void gs2_hmsb_setpixel(const mp_obj_framebuf_t *fb, int x, int y, uint32_t col) {
      uint8_t *pixel = &((uint8_t *)fb->buf)[(x + y * fb->stride) >> 2];
      uint8_t shift = (x & 0x3) << 1;
      uint8_t mask = 0x3 << shift;
      uint8_t color = (col & 0x3) << shift;
      *pixel = color | (*pixel & (~mask));
  }
  
  STATIC uint32_t gs2_hmsb_getpixel(const mp_obj_framebuf_t *fb, int x, int y) {
      uint8_t pixel = ((uint8_t *)fb->buf)[(x + y * fb->stride) >> 2];
      uint8_t shift = (x & 0x3) << 1;
      return (pixel >> shift) & 0x3;
  }
  
  STATIC void gs2_hmsb_fill_rect(const mp_obj_framebuf_t *fb, int x, int y, int w, int h, uint32_t col) {
      for (int xx = x; xx < x + w; xx++) {
          for (int yy = y; yy < y + h; yy++) {
              gs2_hmsb_setpixel(fb, xx, yy, col);
          }
      }
  }
  
  // Functions for GS4_HMSB format
  
  STATIC void gs4_hmsb_setpixel(const mp_obj_framebuf_t *fb, int x, int y, uint32_t col) {
      uint8_t *pixel = &((uint8_t *)fb->buf)[(x + y * fb->stride) >> 1];
  
      if (x % 2) {
          *pixel = ((uint8_t)col & 0x0f) | (*pixel & 0xf0);
      } else {
          *pixel = ((uint8_t)col << 4) | (*pixel & 0x0f);
      }
  }
  
  STATIC uint32_t gs4_hmsb_getpixel(const mp_obj_framebuf_t *fb, int x, int y) {
      if (x % 2) {
          return ((uint8_t *)fb->buf)[(x + y * fb->stride) >> 1] & 0x0f;
      }
  
      return ((uint8_t *)fb->buf)[(x + y * fb->stride) >> 1] >> 4;
  }
  
  STATIC void gs4_hmsb_fill_rect(const mp_obj_framebuf_t *fb, int x, int y, int w, int h, uint32_t col) {
      col &= 0x0f;
      uint8_t *pixel_pair = &((uint8_t *)fb->buf)[(x + y * fb->stride) >> 1];
      uint8_t col_shifted_left = col << 4;
      uint8_t col_pixel_pair = col_shifted_left | col;
      int pixel_count_till_next_line = (fb->stride - w) >> 1;
      bool odd_x = (x % 2 == 1);
  
      while (h--) {
          int ww = w;
  
          if (odd_x && ww > 0) {
              *pixel_pair = (*pixel_pair & 0xf0) | col;
              pixel_pair++;
              ww--;
          }
  
          memset(pixel_pair, col_pixel_pair, ww >> 1);
          pixel_pair += ww >> 1;
  
          if (ww % 2) {
              *pixel_pair = col_shifted_left | (*pixel_pair & 0x0f);
              if (!odd_x) {
                  pixel_pair++;
              }
          }
  
          pixel_pair += pixel_count_till_next_line;
      }
  }
  
  // Functions for GS8 format
  
  STATIC void gs8_setpixel(const mp_obj_framebuf_t *fb, int x, int y, uint32_t col) {
      uint8_t *pixel = &((uint8_t *)fb->buf)[(x + y * fb->stride)];
      *pixel = col & 0xff;
  }
  
  STATIC uint32_t gs8_getpixel(const mp_obj_framebuf_t *fb, int x, int y) {
      return ((uint8_t *)fb->buf)[(x + y * fb->stride)];
  }
  
  STATIC void gs8_fill_rect(const mp_obj_framebuf_t *fb, int x, int y, int w, int h, uint32_t col) {
      uint8_t *pixel = &((uint8_t *)fb->buf)[(x + y * fb->stride)];
      while (h--) {
          memset(pixel, col, w);
          pixel += fb->stride;
      }
  }
  
  STATIC mp_framebuf_p_t formats[] = {
      [FRAMEBUF_MVLSB] = {MP_PROTO_IMPLEMENT(MP_QSTR_protocol_framebuf) mvlsb_setpixel, mvlsb_getpixel, mvlsb_fill_rect},
      [FRAMEBUF_RGB565] = {MP_PROTO_IMPLEMENT(MP_QSTR_protocol_framebuf) rgb565_setpixel, rgb565_getpixel, rgb565_fill_rect},
      [FRAMEBUF_GS2_HMSB] = {MP_PROTO_IMPLEMENT(MP_QSTR_protocol_framebuf) gs2_hmsb_setpixel, gs2_hmsb_getpixel, gs2_hmsb_fill_rect},
      [FRAMEBUF_GS4_HMSB] = {MP_PROTO_IMPLEMENT(MP_QSTR_protocol_framebuf) gs4_hmsb_setpixel, gs4_hmsb_getpixel, gs4_hmsb_fill_rect},
      [FRAMEBUF_GS8] = {MP_PROTO_IMPLEMENT(MP_QSTR_protocol_framebuf) gs8_setpixel, gs8_getpixel, gs8_fill_rect},
      [FRAMEBUF_MHLSB] = {MP_PROTO_IMPLEMENT(MP_QSTR_protocol_framebuf) mono_horiz_setpixel, mono_horiz_getpixel, mono_horiz_fill_rect},
      [FRAMEBUF_MHMSB] = {MP_PROTO_IMPLEMENT(MP_QSTR_protocol_framebuf) mono_horiz_setpixel, mono_horiz_getpixel, mono_horiz_fill_rect},
  };
  
  static inline void setpixel(const mp_obj_framebuf_t *fb, int x, int y, uint32_t col) {
      formats[fb->format].setpixel(fb, x, y, col);
  }
  
  static inline uint32_t getpixel(const mp_obj_framebuf_t *fb, int x, int y) {
      return formats[fb->format].getpixel(fb, x, y);
  }
  
  STATIC void fill_rect(const mp_obj_framebuf_t *fb, int x, int y, int w, int h, uint32_t col) {
      if (h < 1 || w < 1 || x + w <= 0 || y + h <= 0 || y >= fb->height || x >= fb->width) {
          // No operation needed.
          return;
      }
  
      // clip to the framebuffer
      int xend = MIN(fb->width, x + w);
      int yend = MIN(fb->height, y + h);
      x = MAX(x, 0);
      y = MAX(y, 0);
  
      formats[fb->format].fill_rect(fb, x, y, xend - x, yend - y, col);
  }
  
  STATIC mp_obj_t framebuf_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *args, mp_map_t *kw_args) {
      mp_arg_check_num(n_args, kw_args, 4, 5, false);
  
      mp_obj_framebuf_t *o = m_new_obj(mp_obj_framebuf_t);
      o->base.type = type;
      o->buf_obj = args[0];
  
      mp_buffer_info_t bufinfo;
      mp_get_buffer_raise(args[0], &bufinfo, MP_BUFFER_WRITE);
      o->buf = bufinfo.buf;
  
      o->width = mp_obj_get_int(args[1]);
      o->height = mp_obj_get_int(args[2]);
      o->format = mp_obj_get_int(args[3]);
      if (n_args >= 5) {
          o->stride = mp_obj_get_int(args[4]);
      } else {
          o->stride = o->width;
      }
  
      switch (o->format) {
          case FRAMEBUF_MVLSB:
          case FRAMEBUF_RGB565:
              break;
          case FRAMEBUF_MHLSB:
          case FRAMEBUF_MHMSB:
              o->stride = (o->stride + 7) & ~7;
              break;
          case FRAMEBUF_GS2_HMSB:
              o->stride = (o->stride + 3) & ~3;
              break;
          case FRAMEBUF_GS4_HMSB:
              o->stride = (o->stride + 1) & ~1;
              break;
          case FRAMEBUF_GS8:
              break;
          default:
              mp_raise_ValueError(translate("invalid format"));
      }
  
      return MP_OBJ_FROM_PTR(o);
  }
  
  STATIC const mp_obj_type_t mp_type_framebuf;
  
  // Helper to ensure we have the native super class instead of a subclass.
  static mp_obj_framebuf_t *native_framebuf(mp_obj_t framebuf_obj) {
      mp_obj_t native_framebuf = mp_instance_cast_to_native_base(framebuf_obj, &mp_type_framebuf);
      mp_obj_assert_native_inited(native_framebuf);
      return MP_OBJ_TO_PTR(native_framebuf);
  }
  
  STATIC mp_int_t framebuf_get_buffer(mp_obj_t self_in, mp_buffer_info_t *bufinfo, mp_uint_t flags) {
      (void)flags;
      mp_obj_framebuf_t *self = native_framebuf(self_in);
      bufinfo->buf = self->buf;
      bufinfo->len = self->stride * self->height * (self->format == FRAMEBUF_RGB565 ? 2 : 1);
      bufinfo->typecode = 'B'; // view framebuf as bytes
      return 0;
  }
  
  STATIC mp_obj_t framebuf_fill(mp_obj_t self_in, mp_obj_t col_in) {
      mp_obj_framebuf_t *self = native_framebuf(self_in);
      mp_int_t col = mp_obj_get_int(col_in);
      formats[self->format].fill_rect(self, 0, 0, self->width, self->height, col);
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_2(framebuf_fill_obj, framebuf_fill);
  
  STATIC mp_obj_t framebuf_fill_rect(size_t n_args, const mp_obj_t *args) {
      (void)n_args;
  
      mp_obj_framebuf_t *self = native_framebuf(args[0]);
      mp_int_t x = mp_obj_get_int(args[1]);
      mp_int_t y = mp_obj_get_int(args[2]);
      mp_int_t width = mp_obj_get_int(args[3]);
      mp_int_t height = mp_obj_get_int(args[4]);
      mp_int_t col = mp_obj_get_int(args[5]);
  
      fill_rect(self, x, y, width, height, col);
  
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(framebuf_fill_rect_obj, 6, 6, framebuf_fill_rect);
  
  STATIC mp_obj_t framebuf_pixel(size_t n_args, const mp_obj_t *args) {
      mp_obj_framebuf_t *self = native_framebuf(args[0]);
      mp_int_t x = mp_obj_get_int(args[1]);
      mp_int_t y = mp_obj_get_int(args[2]);
      if (0 <= x && x < self->width && 0 <= y && y < self->height) {
          if (n_args == 3) {
              // get
              return MP_OBJ_NEW_SMALL_INT(getpixel(self, x, y));
          } else {
              // set
              setpixel(self, x, y, mp_obj_get_int(args[3]));
          }
      }
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(framebuf_pixel_obj, 3, 4, framebuf_pixel);
  
  STATIC mp_obj_t framebuf_hline(size_t n_args, const mp_obj_t *args) {
      (void)n_args;
  
      mp_obj_framebuf_t *self = native_framebuf(args[0]);
      mp_int_t x = mp_obj_get_int(args[1]);
      mp_int_t y = mp_obj_get_int(args[2]);
      mp_int_t w = mp_obj_get_int(args[3]);
      mp_int_t col = mp_obj_get_int(args[4]);
  
      fill_rect(self, x, y, w, 1, col);
  
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(framebuf_hline_obj, 5, 5, framebuf_hline);
  
  STATIC mp_obj_t framebuf_vline(size_t n_args, const mp_obj_t *args) {
      (void)n_args;
  
      mp_obj_framebuf_t *self = native_framebuf(args[0]);
      mp_int_t x = mp_obj_get_int(args[1]);
      mp_int_t y = mp_obj_get_int(args[2]);
      mp_int_t h = mp_obj_get_int(args[3]);
      mp_int_t col = mp_obj_get_int(args[4]);
  
      fill_rect(self, x, y, 1, h, col);
  
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(framebuf_vline_obj, 5, 5, framebuf_vline);
  
  STATIC mp_obj_t framebuf_rect(size_t n_args, const mp_obj_t *args) {
      (void)n_args;
  
      mp_obj_framebuf_t *self = native_framebuf(args[0]);
      mp_int_t x = mp_obj_get_int(args[1]);
      mp_int_t y = mp_obj_get_int(args[2]);
      mp_int_t w = mp_obj_get_int(args[3]);
      mp_int_t h = mp_obj_get_int(args[4]);
      mp_int_t col = mp_obj_get_int(args[5]);
  
      fill_rect(self, x, y, w, 1, col);
      fill_rect(self, x, y + h - 1, w, 1, col);
      fill_rect(self, x, y, 1, h, col);
      fill_rect(self, x + w - 1, y, 1, h, col);
  
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(framebuf_rect_obj, 6, 6, framebuf_rect);
  
  STATIC mp_obj_t framebuf_line(size_t n_args, const mp_obj_t *args) {
      (void)n_args;
  
      mp_obj_framebuf_t *self = native_framebuf(args[0]);
      mp_int_t x1 = mp_obj_get_int(args[1]);
      mp_int_t y1 = mp_obj_get_int(args[2]);
      mp_int_t x2 = mp_obj_get_int(args[3]);
      mp_int_t y2 = mp_obj_get_int(args[4]);
      mp_int_t col = mp_obj_get_int(args[5]);
  
      mp_int_t dx = x2 - x1;
      mp_int_t sx;
      if (dx > 0) {
          sx = 1;
      } else {
          dx = -dx;
          sx = -1;
      }
  
      mp_int_t dy = y2 - y1;
      mp_int_t sy;
      if (dy > 0) {
          sy = 1;
      } else {
          dy = -dy;
          sy = -1;
      }
  
      bool steep;
      if (dy > dx) {
          mp_int_t temp;
          temp = x1;
          x1 = y1;
          y1 = temp;
          temp = dx;
          dx = dy;
          dy = temp;
          temp = sx;
          sx = sy;
          sy = temp;
          steep = true;
      } else {
          steep = false;
      }
  
      mp_int_t e = 2 * dy - dx;
      for (mp_int_t i = 0; i < dx; ++i) {
          if (steep) {
              if (0 <= y1 && y1 < self->width && 0 <= x1 && x1 < self->height) {
                  setpixel(self, y1, x1, col);
              }
          } else {
              if (0 <= x1 && x1 < self->width && 0 <= y1 && y1 < self->height) {
                  setpixel(self, x1, y1, col);
              }
          }
          while (e >= 0) {
              y1 += sy;
              e -= 2 * dx;
          }
          x1 += sx;
          e += 2 * dy;
      }
  
      if (0 <= x2 && x2 < self->width && 0 <= y2 && y2 < self->height) {
          setpixel(self, x2, y2, col);
      }
  
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(framebuf_line_obj, 6, 6, framebuf_line);
  
  STATIC mp_obj_t framebuf_blit(size_t n_args, const mp_obj_t *args) {
      mp_obj_framebuf_t *self = native_framebuf(args[0]);
      mp_obj_framebuf_t *source = native_framebuf(args[1]);
      mp_int_t x = mp_obj_get_int(args[2]);
      mp_int_t y = mp_obj_get_int(args[3]);
      mp_int_t key = -1;
      if (n_args > 4) {
          key = mp_obj_get_int(args[4]);
      }
  
      if (
          (x >= self->width) ||
          (y >= self->height) ||
          (-x >= source->width) ||
          (-y >= source->height)
          ) {
          // Out of bounds, no-op.
          return mp_const_none;
      }
  
      // Clip.
      int x0 = MAX(0, x);
      int y0 = MAX(0, y);
      int x1 = MAX(0, -x);
      int y1 = MAX(0, -y);
      int x0end = MIN(self->width, x + source->width);
      int y0end = MIN(self->height, y + source->height);
  
      for (; y0 < y0end; ++y0) {
          int cx1 = x1;
          for (int cx0 = x0; cx0 < x0end; ++cx0) {
              uint32_t col = getpixel(source, cx1, y1);
              if (col != (uint32_t)key) {
                  setpixel(self, cx0, y0, col);
              }
              ++cx1;
          }
          ++y1;
      }
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(framebuf_blit_obj, 4, 5, framebuf_blit);
  
  STATIC mp_obj_t framebuf_scroll(mp_obj_t self_in, mp_obj_t xstep_in, mp_obj_t ystep_in) {
      mp_obj_framebuf_t *self = native_framebuf(self_in);
      mp_int_t xstep = mp_obj_get_int(xstep_in);
      mp_int_t ystep = mp_obj_get_int(ystep_in);
      int sx, y, xend, yend, dx, dy;
      if (xstep < 0) {
          sx = 0;
          xend = self->width + xstep;
          dx = 1;
      } else {
          sx = self->width - 1;
          xend = xstep - 1;
          dx = -1;
      }
      if (ystep < 0) {
          y = 0;
          yend = self->height + ystep;
          dy = 1;
      } else {
          y = self->height - 1;
          yend = ystep - 1;
          dy = -1;
      }
      for (; y != yend; y += dy) {
          for (int x = sx; x != xend; x += dx) {
              setpixel(self, x, y, getpixel(self, x - xstep, y - ystep));
          }
      }
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_3(framebuf_scroll_obj, framebuf_scroll);
  
  STATIC mp_obj_t framebuf_text(size_t n_args, const mp_obj_t *args) {
      // extract arguments
      mp_obj_framebuf_t *self = native_framebuf(args[0]);
      const char *str = mp_obj_str_get_str(args[1]);
      mp_int_t x0 = mp_obj_get_int(args[2]);
      mp_int_t y0 = mp_obj_get_int(args[3]);
      mp_int_t col = 1;
      if (n_args >= 5) {
          col = mp_obj_get_int(args[4]);
      }
  
      // loop over chars
      for (; *str; ++str) {
          // get char and make sure its in range of font
          int chr = *(uint8_t *)str;
          if (chr < 32 || chr > 127) {
              chr = 127;
          }
          // get char data
          const uint8_t *chr_data = &font_petme128_8x8[(chr - 32) * 8];
          // loop over char data
          for (int j = 0; j < 8; j++, x0++) {
              if (0 <= x0 && x0 < self->width) { // clip x
                  uint vline_data = chr_data[j]; // each byte is a column of 8 pixels, LSB at top
                  for (int y = y0; vline_data; vline_data >>= 1, y++) { // scan over vertical column
                      if (vline_data & 1) { // only draw if pixel set
                          if (0 <= y && y < self->height) { // clip y
                              setpixel(self, x0, y, col);
                          }
                      }
                  }
              }
          }
      }
      return mp_const_none;
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(framebuf_text_obj, 4, 5, framebuf_text);
  
  #if !MICROPY_ENABLE_DYNRUNTIME
  STATIC const mp_rom_map_elem_t framebuf_locals_dict_table[] = {
      { MP_ROM_QSTR(MP_QSTR_fill), MP_ROM_PTR(&framebuf_fill_obj) },
      { MP_ROM_QSTR(MP_QSTR_fill_rect), MP_ROM_PTR(&framebuf_fill_rect_obj) },
      { MP_ROM_QSTR(MP_QSTR_pixel), MP_ROM_PTR(&framebuf_pixel_obj) },
      { MP_ROM_QSTR(MP_QSTR_hline), MP_ROM_PTR(&framebuf_hline_obj) },
      { MP_ROM_QSTR(MP_QSTR_vline), MP_ROM_PTR(&framebuf_vline_obj) },
      { MP_ROM_QSTR(MP_QSTR_rect), MP_ROM_PTR(&framebuf_rect_obj) },
      { MP_ROM_QSTR(MP_QSTR_line), MP_ROM_PTR(&framebuf_line_obj) },
      { MP_ROM_QSTR(MP_QSTR_blit), MP_ROM_PTR(&framebuf_blit_obj) },
      { MP_ROM_QSTR(MP_QSTR_scroll), MP_ROM_PTR(&framebuf_scroll_obj) },
      { MP_ROM_QSTR(MP_QSTR_text), MP_ROM_PTR(&framebuf_text_obj) },
  };
  STATIC MP_DEFINE_CONST_DICT(framebuf_locals_dict, framebuf_locals_dict_table);
  
  STATIC const mp_obj_type_t mp_type_framebuf = {
      { &mp_type_type },
      .name = MP_QSTR_FrameBuffer,
      .make_new = framebuf_make_new,
      .buffer_p = { .get_buffer = framebuf_get_buffer },
      .locals_dict = (mp_obj_dict_t *)&framebuf_locals_dict,
  };
  #endif
  
  // this factory function is provided for backwards compatibility with old FrameBuffer1 class
  STATIC mp_obj_t legacy_framebuffer1(size_t n_args, const mp_obj_t *args) {
      mp_obj_framebuf_t *o = m_new_obj(mp_obj_framebuf_t);
      o->base.type = &mp_type_framebuf;
  
      mp_buffer_info_t bufinfo;
      mp_get_buffer_raise(args[0], &bufinfo, MP_BUFFER_WRITE);
      o->buf = bufinfo.buf;
  
      o->width = mp_obj_get_int(args[1]);
      o->height = mp_obj_get_int(args[2]);
      o->format = FRAMEBUF_MVLSB;
      if (n_args >= 4) {
          o->stride = mp_obj_get_int(args[3]);
      } else {
          o->stride = o->width;
      }
  
      return MP_OBJ_FROM_PTR(o);
  }
  STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(legacy_framebuffer1_obj, 3, 4, legacy_framebuffer1);
  
  #if !MICROPY_ENABLE_DYNRUNTIME
  STATIC const mp_rom_map_elem_t framebuf_module_globals_table[] = {
      { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_framebuf) },
      { MP_ROM_QSTR(MP_QSTR_FrameBuffer), MP_ROM_PTR(&mp_type_framebuf) },
      { MP_ROM_QSTR(MP_QSTR_FrameBuffer1), MP_ROM_PTR(&legacy_framebuffer1_obj) },
      { MP_ROM_QSTR(MP_QSTR_MVLSB), MP_ROM_INT(FRAMEBUF_MVLSB) },
      { MP_ROM_QSTR(MP_QSTR_MONO_VLSB), MP_ROM_INT(FRAMEBUF_MVLSB) },
      { MP_ROM_QSTR(MP_QSTR_RGB565), MP_ROM_INT(FRAMEBUF_RGB565) },
      { MP_ROM_QSTR(MP_QSTR_GS2_HMSB), MP_ROM_INT(FRAMEBUF_GS2_HMSB) },
      { MP_ROM_QSTR(MP_QSTR_GS4_HMSB), MP_ROM_INT(FRAMEBUF_GS4_HMSB) },
      { MP_ROM_QSTR(MP_QSTR_GS8), MP_ROM_INT(FRAMEBUF_GS8) },
      { MP_ROM_QSTR(MP_QSTR_MONO_HLSB), MP_ROM_INT(FRAMEBUF_MHLSB) },
      { MP_ROM_QSTR(MP_QSTR_MONO_HMSB), MP_ROM_INT(FRAMEBUF_MHMSB) },
  };
  
  STATIC MP_DEFINE_CONST_DICT(framebuf_module_globals, framebuf_module_globals_table);
  
  const mp_obj_module_t mp_module_framebuf = {
      .base = { &mp_type_module },
      .globals = (mp_obj_dict_t *)&framebuf_module_globals,
  };
  #endif
  
  #endif // MICROPY_PY_FRAMEBUF
  