[ESP32]Adafruit GFX Library API まとめ with Arduino IDE

Adafruit GFX Library とは、Adafruit社が提供しているライブラリで、グラフィックスライブラリの派生元となる「コア」クラスです。

Adafruit社のすべての LCD および OLED ディスプレイと LED マトリックスに使用することができ、共通の構文とグラフィック関数のセットが提供されています。これにより、Arduino スケッチを最小限の手間でディスプレイ タイプに簡単に適応させることができます。

virtual void setRotation(uint8_t r);
引数
・r — 0＝標準、1＝時計回りに90度回転、2＝時計回りに180度回転、3＝時計回りに270度回転。

描画前に設定します。
※描画後に設定し画面が回転するものではありません。

virtual void invertDisplay(bool i);
引数
・i — true＝通常表示、false＝反転表示。

描画後に設定します。
※画面全体の色が反転表示されます。

class Adafruit_GFX
virtual void fillScreen(uint16_t color);
引数
・color — 色設定（16-bit (‘565’) color）。

1色で画面全体を塗りつぶします。

class Adafruit_SPITFT
void drawPixel(int16_t x, int16_t y, uint16_t color);
引数
・x — 表示ｘ座標。
・y — 表示ｙ座標。
・color — 色設定（16-bit (‘565’) color）。

1ピクセルの点を描画します。

class Adafruit_SPITFT
void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
引数
・x — 表示ｘ座標。
・y — 表示ｙ座標。
・h — 縦線長さ。
・color — 色設定（16-bit (‘565’) color）。

(x,y) から下方向へ h の長さ線を描画します。

class Adafruit_SPITFT
void drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
引数
・x — 表示ｘ座標。
・y — 表示ｙ座標。
・w — 横線長さ。
・color — 色設定（16-bit (‘565’) color）。

(x,y) から右方向へ w の長さ線を描画します。

class Adafruit_SPITFT
void fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
引数
・x — 表示ｘ座標。
・y — 表示ｙ座標。
・w — 横辺長さ。
・h — 縦辺長さ。
・color — 色設定（16-bit (‘565’) color）。

(x,y) から右方向へ w 下方向へ h の長さ分の四角形を塗りつぶし描画します。

class Adafruit_GFX
virtual void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);
引数
・x0 — 表示開始ｘ座標。
・y0 — 表示開始ｙ座標。
・x1 — 表示終了ｘ座標。
・y1 — 表示終了ｙ座標。
・color — 色設定（16-bit (‘565’) color）。

(x0,y0) から (x1,y1) へ 直線を描画します。

class Adafruit_GFX
virtual void drawRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
引数
・x — 表示開始ｘ座標。
・y — 表示開始ｙ座標。
・w — 横辺長さ。
・h — 縦辺長さ。
・color — 色設定（16-bit (‘565’) color）。

(x,y) から右方向へ w 下方向へ h の長さ分の四角形を描画します。

class Adafruit_GFX
void drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
引数
・x0 — 表示開始ｘ座標。
・y0 — 表示開始ｙ座標。
・r — 半径。
・color — 色設定（16-bit (‘565’) color）。

(x0,y0) を中心に半径 r の円を描画します。

class Adafruit_GFX
void fillCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
引数
・x0 — 表示開始ｘ座標。
・y0 — 表示開始ｙ座標。
・r — 半径。
・color — 色設定（16-bit (‘565’) color）。

(x0,y0) を中心に半径 r の円を塗りつぶし描画します。

class Adafruit_GFX
void fillCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername, int16_t delta, uint16_t color);
引数
・x0 — 表示開始ｘ座標。
・y0 — 表示開始ｙ座標。
・r — 半径。
・cornername — コーナーを指定するマスクビット。
　　　　　　　　　0x01＝右側半分。0x02＝左側半分。
・delta — 中心点からのオフセット。
・color — 色設定（16-bit (‘565’) color）。

(x0,y0) を中心に半径 r の円。
delta は下方向に指定長さ分円が伸びるイメージ。
cornername は 0x01(右側半分)と 0x02(左側半分)を指定します。

class Adafruit_GFX
void drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
引数
・x0 — 表示開始（頂点１）ｘ座標。
・y0 — 表示開始（頂点１）ｙ座標。
・x1 — 頂点２ｘ座標。
・y1 — 頂点２ｙ座標。
・x2 — 頂点３ｘ座標。
・y2 — 頂点３ｙ座標。
・color — 色設定（16-bit (‘565’) color）。

３つのｘ,ｙ座標を指定して三角形を描画します。

class Adafruit_GFX
void fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
引数
・x0 — 表示開始（頂点１）ｘ座標。
・y0 — 表示開始（頂点１）ｙ座標。
・x1 — 頂点２ｘ座標。
・y1 — 頂点２ｙ座標。
・x2 — 頂点３ｘ座標。
・y2 — 頂点３ｙ座標。
・color — 色設定（16-bit (‘565’) color）。

３つのｘ,ｙ座標を指定して三角形を塗りつぶし描画します。

class Adafruit_GFX
void drawRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
引数
・x0 — 基点ｘ座標。
・y0 — 基点ｙ座標。
・w — 横幅長さ。
・h — 縦幅長さ。
・radius — 四角形の頂点を丸くする円の半径。
・color — 色設定（16-bit (‘565’) color）。

(x0,y0) を基点にして右下方向へ角丸四角形を描画します。
丸くする円の半径を radius で指定します。

class Adafruit_GFX
void fillRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
引数
・x0 — 基点ｘ座標。
・y0 — 基点ｙ座標。
・w — 横幅長さ。
・h — 縦幅長さ。
・radius — 四角形の頂点を丸くする円の半径。
・color — 色設定（16-bit (‘565’) color）。

(x0,y0) を基点にして右下方向へ角丸四角形を描画します。
丸くする円の半径を radius で指定します。

class Adafruit_GFX
void drawChar(int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size);
void drawChar(int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size_x, uint8_t size_y);
引数
・x — 基点ｘ座標。
・y — 基点ｙ座標。
・c — 文字。
・color — 文字色。
・bg — 背景色（文字色と同じ色にすると背景色なし）。
・size — １が標準。標準文字サイズの拡大倍数を設定する。
・(size_x) — 文字サイズ幅。１が標準。標準文字サイズ幅の拡大倍数を設定する。
・(size_y) — 文字サイズ高さ。１が標準。標準文字サイズ高さの拡大倍数を設定する。

(x,y) を基点にして右下方向へ文字を描画します。

標準文字サイズは、幅６ピクセル，高さ８ピクセル。

class Adafruit_GFX
void getTextBounds(const char *string, int16_t x, int16_t y, int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h);
void getTextBounds(const __FlashStringHelper *s, int16_t x, int16_t y, int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h);
void getTextBounds(const String &str, int16_t x, int16_t y, int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h);
引数
・*string(*s,&str) — 文字列。
・x — 文字列表示開始ｘ座標。
・y — 文字列表示開始ｙ座標。
・*x1 — 描画時の左上ｘ座標。
・*y1 — 描画時の左上ｙ座標。
・*w — 描画時の文字列幅を返す。
・*h — 描画時の文字列高さを返す。

現在設定されているフォントとサイズで文字列を描画する時のサイズを計算してくれる関数です。
文字列とカーソル位置を渡し、描画された場合の左上座標と文字幅、文字高さを返します。
描画はされません。

文字列の中央寄せなどにも使用できそうです。

class Adafruit_GFX
void setTextSize(uint8_t s);
void setTextSize(uint8_t sx, uint8_t sy);
引数
・s — 文字サイズ幅。１が標準。標準文字サイズ幅の拡大倍数を設定する。
・(sx) — 文字サイズ幅。１が標準。標準文字サイズ幅の拡大倍数を設定する。
・(sy) — 文字サイズ高さ。１が標準。標準文字サイズ高さの拡大倍数を設定する。

標準文字サイズは、幅６ピクセル，高さ８ピクセル。

文字列描画前に設定しておきます。

class Adafruit_GFX
void setTextSize(uint8_t s);
void setTextSize(uint8_t sx, uint8_t sy);
引数
・s — 文字サイズ幅。１が標準。標準文字サイズ幅の拡大倍数を設定する。
・(sx) — 文字サイズ幅。１が標準。標準文字サイズ幅の拡大倍数を設定する。
・(sy) — 文字サイズ高さ。１が標準。標準文字サイズ高さの拡大倍数を設定する。

標準文字サイズは、幅６ピクセル，高さ８ピクセル。

文字列描画前に設定しておきます。

class Adafruit_GFX
void setFont(const GFXfont *f = NULL);
引数
・*f — フォント。

文字フォントを指定します。

文字列描画前に設定しておきます。

class Adafruit_GFX
void setCursor(int16_t x, int16_t y);
引数
・x — ｘ座標（ピクセル単位）。
・y — ｙ座標（ピクセル単位）。

現在のカーソル座標をピクセルで設定します。

class Adafruit_GFX
void setTextColor(uint16_t c);
void setTextColor(uint16_t c, uint16_t bg);
引数
・c — テキスト色設定（16-bit (‘565’) color）。
・bg — 背景色設定（16-bit (‘565’) color）。

背景色を指定しない場合、またはテキスト色と背景色を同色にした場合は、背景は透明になります。

class Adafruit_GFX
void setTextWrap(bool w);
引数
・w — 折り返し設定。
　　　 true=折り返し有り。false＝折り返しなし。

テキストが画面からはみ出る場合の折り返し設定をします。

class Adafruit_GFX
int16_t width(void);
戻り値
・画面幅。

現在の回転を考慮して画面の幅を取得します。

class Adafruit_GFX
int16_t height(void);
戻り値
・画面高さ。

現在の回転を考慮して画面の高さを取得します。

class Adafruit_GFX
uint8_t getRotation(void);
戻り値
・画面回転設定。
　0＝標準、1＝時計回りに90度回転、2＝時計回りに180度回転、3＝時計回りに270度回転。

画面の回転設定を取得します。

class Adafruit_GFX
int16_t getCursorX(void);
戻り値
・カーソルｘ座標。

現在のカーソルｘ座標を取得します。

class Adafruit_GFX
int16_t getCursorY(void);
戻り値
・カーソルｙ座標。

現在のカーソルｙ座標を取得します。