フォント定義クラス
フォント定義と関連する手続きをまとめたクラスです。
このクラスオブジェクトはフォントジェネレータcreateFont???()によりライブラリ内部で生成・管理され、ユーザがコンストラクタを用いて直接オブジェクトを生成することはありません。
パラメータを省略した場合は、フォントのシングル幅文字の幅を返します。この値にはフォント生成時に指定した文字間スペースも含まれます。
wcを指定した場合は、Unicode wcに対応するフォントの幅を返します。日本語などダブル幅のフォントの場合は、シングル幅の２倍の値が戻ります。
フォントの高さを返します。この値にはフォント生成時に指定した行間スペースも含まれます。
デフォルトフォントのオブジェクトである場合 true を返します。
デフォルトフォントのオブジェクトはcreateFont???()やqueryFont()のエラー時など例外時にも利用されます。
フォントIDを取得します。
Unicode c に対応する、ダブル幅フォント定義配列インデックスを検索します。
戻り値は、字形データが存在する場合は、インデックス配列のインデックス（データ配列のインデックスが計算できる）、存在しない場合は-1を返します。
フォント定義は、インデックス配列、データ配列の２つから構成されます。インデックス配列の各値は昇順に並んだ Unicode になっていて、データ配列のインデックスに対応しています。
以下の例ではインデックス配列の IDX=829 が U+5a2f で "娯" という文字です。データ配列の対応する番地を参照すれば、この字形データが格納されています。
インデックス配列内の値は昇順に並ぶよう構成した目的は、本関数で実装されている二分探索を利用するためです。
フォントジェネレータ関数
フォントジェネレータ関数は、収録フォントごとに定義されています。関数パラメータは共通で、以下のようになります。
上記は東雲フォント16ドット版（常用漢字収録）のジェネレータの例です。
idは、ユーザが指定するフォントID。
line_spaceはフォントの行間スペースをピクセル数で指定します。
char_spaceは文字間スペースでピクセルで指定します。文字間スペースはシングル幅のフォントの指定です。ダブル幅のフォントの場合は倍になります。
u32Optは、フォントのオプションを指定します。オプションはU32_OPT_FONT_TATEBAIとU32_OPT_FONT_YOKOBAIがあり、論理和で指定します。
フォントジェネレータの戻り値はFontDef&になっています。この戻り値はライブラリ内部のフォント管理テーブルに生成されたオブジェクトへの参照です。既に登録済みのIDであるばあいは、そのIDに対して上書きを行います。登録できなかった場合は.is_default()メソッドがtrueになるデフォルトフォントが返されます。
フォントの描画
フォントをスクリーン上に描画します。
以下の例では、Bボタンを押すたびに、事前に生成したフォントID=10のフォントを用いて固定の文字列を描画します。
fontを用い、左上座標(x,y)に、文字色fg、背景色bg、オプションoptで文字を描画します。
uint16_t cをパラメターとして与えた場合は、Unicode c に対応する文字を１文字描画します。
const char *sをパラメータとして与えた場合は、sをUTF-8としてデコードし、文字列として出力します。
const uint16_t* sをパラメータとして与えた場合は、Unicode文字列として描画します。
optはオプションのビットマップです。以下の指定が可能です。
0x01 - 太字指定
0x02 - カーソルの描画
戻り値は、描画が行われればX(幅)方向に描画したピクセル数を返し、エラーなどが発生したときは0を返します。
実装時では以下のM5StackのAPIを利用しています。
M5.Lcd.startWrite()
M5.Lcd.setWindow()
M5.Lcd.endWrite()
tft_Write_16()
フォント定義や描画
namespace TWEFONT には、フォントの定義やフォント描画のための手続きをまとめています。
このフォントライブラリは M5Stack 標準のライブラリのフォントには準じていないため M5Stackでのフォント描画APIなどで使用することが出来ません。
フォントはFontDefクラスにより管理されます。フォントごとに用意されるFontDefクラスオブジェクトのジェネレータ関数により生成され、ライブラリ内部で生成時に指定したフォントIDと紐づけて管理されます。フォントは最大７つまで定義できます。フォント作成時に字間・行間・倍角を指定することができます。同じフォントに対して複数のフォントIDの登録が可能です。
下記の例では、フォントID 10 に16ドットの東雲フォント（縦倍角・横倍角指定）を、フォントIDを11に同じフォントですが倍角指定なし、行間を１ピクセルとしたフォント定義を行います。
コンパイル時に、ジェネレータ関数createFont???()を呼び出されたフォントのデータがリンクされます。
フォントの登録した種類だけROM容量が必要になります。最小限のフォントを選択するようにしてください。
本ライブラリには、作者が事実上パブリックドメイン（著作権等取扱はソースヘッダに含まれるクレジットを参照ください）を宣言しているフォントをいくつか含めています。
本ライブラリに含めるにあたって、以下の調整を行っています。
大本がBDF形式を変換し、描画ルーチンに適したデータ構造とした
これらフォントをUnicodeとして取り扱うための参照テーブルを用意した
latin1補助文字 U+00A0～u+00FFについて、フォント定義があるものについては収録した
JIS X201 半角カナ U+FF61～U+FF9F について、フォント定義があるものについては収録した
常用漢字（2645 文字）のフォントデータと、全収録（東雲フォントのみ、一部未収録字形があります）を用意した
ジェネレータ関数createFont???()には収録文字数に応じて３種類のジェネレータを用意しています。文字セットの生成は{MWM5ライブラリ}/fontsフォルダにあるスクリプトによって行います。
全収録版(_full)は字形データが多いためより多くのROM容量が必要です。同じフォントサイズのデータで常用版と全収録版の両方を登録する意味はありません。常用漢字版の字形データは全収録版に包含されるためです。
12,14,16ドット版をライブラリに含めています。
常用漢字のみのジェネレータ (createFontShinonome12???(), createFontShinonome14???() , createFontShinonome16???())を呼び出します。
ジェネレータ createFontMP10???()または createFontMP12???() を呼び出します。
ジェネレータ createFontLcd8x6() を呼び出します。
latin拡張文字や日本語フォントは含まれません。
このフォントはいずれかのジェネレータ関数createFont???()が呼び出されたときに、デフォルトとしてフォントID=0に登録されます。
フォントIDは作成したフォントごとに割り当てられます。
IDは 0..32 の値を指定可能ですが、ユーザが登録できるのは 1..32 で最大７フォント登録できます。
ID=0 のフォントは 8x6 LCD フォントに割り当てられます。
フォント情報にアクセスするためには、によりオブジェクトを取得し、諸情報を得ます。
ターミナルにフォントを指定するには、フォントの生成を行い、フォントIDをターミナルオブジェクトに指定します。フォント指定後はメソッドによる再描画を行います。
ターミナルのフォント変更は、によりフォントを指定し、その後、とを呼び出します。
関数を用いて描画することができます。
ジェネレータ | ワイド幅 文字数 | 収録 |
| 576 | ASCII, latin1拡張, JIS-X201(半角ｶﾅ:0xA1-DF), かな,カナ,記号(選別), 漢字(選別:MWM5ソース中に出現する文字をスクリプトにより抽出・追加), スクリプト指定文字 |
| 2645 | ASCII, latin1拡張, JIS-X201(半角ｶﾅ:0xA1-DF), かな,カナ,記号,常用漢字,スクリプト指定文字 |
| 6867 | ASCII, latin1拡張, JIS-X201(半角ｶﾅ:0xA1-DF), かな,カナ,記号,漢字,スクリプト指定文字 |