trezor-firmware/core/embed/lib/gfx_draw.h

/*
 * This file is part of the Trezor project, https://trezor.io/
 *
 * Copyright (c) SatoshiLabs
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GFX_DRAW_H
#define GFX_DRAW_H

#include "gfx_color.h"

// 2D rectangle coordinates
//
// `x0`, `y0` - top-left coordinates
// `x1`, `y1` - bottom-right coordinates point (not included)
typedef struct {
  int16_t x0;
  int16_t y0;
  int16_t x1;
  int16_t y1;
} gfx_rect_t;

// Builds a rectangle (`gfx_rect_t`) from top-left coordinates and dimensions
static inline gfx_rect_t gfx_rect_wh(int16_t x, int16_t y, int16_t w,
                                     int16_t h) {
  gfx_rect_t rect = {
      .x0 = x,
      .y0 = y,
      .x1 = x + w,
      .y1 = y + h,
  };

  return rect;
}

// Builds a rectangle (`gfx_rect_t`) from top-left and bottom-right coordinates
static inline gfx_rect_t gfx_rect(int16_t x0, int16_t y0, int16_t x1,
                                  int16_t y1) {
  gfx_rect_t rect = {
      .x0 = x0,
      .y0 = y0,
      .x1 = x1,
      .y1 = y1,
  };

  return rect;
}

// 2D offset/ coordinates
typedef struct {
  int16_t x;
  int16_t y;
} gfx_offset_t;

// Builds a `gfx_offset_t` structure
static inline gfx_offset_t gfx_offset(int16_t x, int16_t y) {
  gfx_offset_t offset = {
      .x = x,
      .y = y,
  };

  return offset;
}

// 2D size in pixels
typedef struct {
  int16_t x;
  int16_t y;
} gfx_size_t;

// Builds a `gfx_size_t` structure
static inline gfx_size_t gfx_size(int16_t x, int16_t y) {
  gfx_size_t size = {
      .x = x,
      .y = y,
  };

  return size;
}

// Format of pixels in a bitmap
typedef enum {
  GFX_FORMAT_UNKNOWN,   //
  GFX_FORMAT_MONO1P,    // 1-bpp per pixel (packed)
  GFX_FORMAT_MONO4,     // 4-bpp per pixel
  GFX_FORMAT_RGB565,    // 16-bpp per pixel
  GFX_FORMAT_RGBA8888,  // 32-bpp
} gfx_format_t;

// 2D bitmap reference
typedef struct {
  // pointer to top-left pixel
  void* ptr;
  // stride in bytes
  size_t stride;
  // size in pixels
  gfx_size_t size;
  // format of pixels, GFX_FORMAT_xxx
  uint8_t format;
  // offset used when bitmap is drawed using gfx_draw_bitmap()
  gfx_offset_t offset;
  // foreground color (used with MONOx formats)
  gfx_color_t fg_color;
  // background color (used with MONOx formats)
  gfx_color_t bg_color;
} gfx_bitmap_t;

// Text attributes (font and color)
typedef struct {
  // Font identifier
  int font;
  // Foreground color
  gfx_color_t fg_color;
  // Background color
  gfx_color_t bg_color;
} gfx_text_attr_t;

// Clears the display with a black color.
void gfx_clear(void);

// Fills a rectangle with a specified color.
void gfx_draw_bar(gfx_rect_t rect, gfx_color_t color);

// Draws a bitmap into the specified rectangle.
//
// The destination rectangle may not be fully filled if the source bitmap
// is smaller than destination rectangle or if the bitmap is translated by
// an offset partially or completely outside the destination rectangle.
//
// Currently, we use `gfx_draw_bitmap` exclusively for text rendering.
// Not all bitmap formats are supported now. Please see the implementation.
void gfx_draw_bitmap(gfx_rect_t rect, const gfx_bitmap_t* bitmap);

// Horizontal alignment of a text
typedef enum {
  GFX_ALIGN_LEFT,
  GFX_ALIGN_CENTER,
} gfx_text_align_t;

// Draws a text to the specified position.
//
// `offset` - the most left point on the font baseline
// `text` - utf-8 text
// `maxlen` - maximum number of characters displayed (use SIZE_MAX when not
// specified)
// `attr` - font & text color
// `align` - horizontal alignment
void gfx_draw_text(gfx_offset_t offset, const char* text, size_t maxlen,
                   const gfx_text_attr_t* attr, gfx_text_align_t align);

#ifdef TREZOR_PRODTEST
// Draws a QR code to the specified position.
//
// `x`, `y` - center of the QR code
// `scale` - size of a single QR code module
// `data` - utf-8 text
void gfx_draw_qrcode(gfx_offset_t offset, uint8_t scale, const char* data);
#endif

#endif  // GFX_DRAW_H