aliceml.h

#include "aliceml_config.h"
#include "aliceml_color.h"
#include "aliceml_rect.h"
#include "aliceml_string.h"

ソースコードを見る。

マクロ定義
#define	ML_FONTSTYLE_REGULAR   0x0000
	太文字です。
#define	ML_FONTSTYLE_BOLD   0x0001
	イタリック体です。
#define	ML_FONTSTYLE_ITALIC   0x0002
#define	ML_FONTSTYLE_UNDERLINE   0x0004
	下線を引きます。
#define	ML_FONTSTYLE_VERTICAL   0x0008
	縦書き文字にします。
#define	ML_FONTSTYLE_SHADOW   0x0100
	文字に影をつけます。
#define	ML_FONTSTYLE_HEMMING   0x0200
	袋文字にします。
#define	ML_FONTSTYLE_SIMPLEMASK   0x00ff
	ML_SimpleFontに使われるフラグのマスクです。
#define	ML_HAS_FLAG(var, flag)   ((ML_bool)(((var) & (flag)) != 0))
	var が特定のフラグをもっているか調べます。
#define	ML_ABS(x)   ((x) >= 0 ? (x) : -(x))
	絶対値を取得します。
#define	ML_MAX(x, y)   ((x) > (y) ? (x) : (y))
	大きい方の値を取得します。
#define	ML_MIN(x, y)   ((x) < (y) ? (x) : (y))
	小さい方の値を取得します。
#define	ML_MEDIAN(x, min_value, max_value)   ML_MIN((max_value), ML_MAX((min_value), (x)))
	３つの値の中間値を取得します。
#define	ML_NEW(TYPE)   (TYPE *)ML_Malloc(sizeof(TYPE))
	メモリを確保します。
#define	ML_NEW2(TYPE, NUM)   (TYPE *)ML_Malloc(sizeof(TYPE) * (NUM))
	複数のオブジェクトのメモリを確保します。
#define	ML_FREE(PTR)   ML_Free(PTR)
	メモリを解放します。
#define	ML_FREE2(PTR)   ML_Free(PTR)
	一応作っておきます。
#define	ML_GetBool   ML_IsEnabled
	idで示される状態が有効であるかを取得します。
#define	ML_AddCharWChar   ML_AddChar16
#define	ML_AddTextlWChar   ML_AddTextl16
#define	ML_AddTextWChar   ML_AddText16
#define	ML_AddLinklWChar   ML_AddLinkl16
#define	ML_AddLinkWChar   ML_AddLink16
#define	ML_AddTextWithRubyWChar   ML_AddTextWithRuby16
型定義
typedef int	ML_FontStyle
	フォントスタイルです。or演算で複数を指定できます。
typedef struct ML_Message	ML_Message
typedef struct ML_Backend	ML_Backend
typedef struct ML_Surface	ML_Surface
typedef struct ML_Command	ML_Command
typedef struct ML_Font	ML_Font
typedef struct ML_CodeConverter	ML_CodeConverter
typedef void(ALICEMLCALL *	ML_Callback )(ML_Message *message)
	種々の変更をユーザーに通知します。
typedef int(ALICEMLCALL *	ML_Callback_Insert )(void *elem)
	オブジェクトの挿入時に呼び出される関数型です。
typedef void(ALICEMLCALL *	ML_Callback_Remove )(void *elem)
	オブジェクトの削除時に呼び出される関数型です。
typedef int(ALICEMLCALL *	ML_Comparator )(const void *elem1, const void *elem2)
	オブジェクトを比較するときに呼ばれる関数型です。
typedef void(ALICEMLCALL *	ML_Callback_Text )(ML_Message *message, ML_bool newpage)
	表示が終わったコマンドをユーザーに通知します。
列挙型
enum	ML_BoolIdentifier {   ML_VERTICAL, ML_CONTINUE_TO_PAUSE, ML_WAIT, ML_PAUSE,   ML_AUTO_NEWLINE, ML_AUTO_NEWPAGE, ML_CHAR_AUTO_HIDE, ML_CHAR_SHOWING,   ML_CHAR_HIDING, ML_AUTO_REFRESH, ML_TAG_MODE }
	ML_Messageの状態値を有効／無効にするときに使います。 [詳細]
enum	ML_IntIdentifier {   ML_AUTOMODE_NEWLINE_WAIT, ML_AUTOMODE_NEWPAGE_WAIT, ML_AUTOMODE_PAUSE_WAIT, ML_TEXT_ALIGN,   ML_LINE_SPACE, ML_CHAR_SPACE, ML_FONT_SIZE, ML_FONT_STYLE,   ML_RUBY_SIZE, ML_RUBY_OFFSET, ML_TEXT_SPEED, ML_CHAR_SHOW_TIME,   ML_CHAR_SHOWING_TIME, ML_CHAR_HIDING_TIME }
	ML_Messageの状態値を変更または取得する時に使います。 [詳細]
enum	ML_Mode { ML_MODE_NORMAL, ML_MODE_AUTO, ML_MODE_SKIP, ML_MODE_SUSPEND }
	メッセージレイヤのモードを示します。 [詳細]
enum	ML_TextAlign {   ML_ALIGN_NORMAL, ML_ALIGN_TOP, ML_ALIGN_BOTTOM, ML_ALIGN_LEFT = ML_ALIGN_TOP,   ML_ALIGN_RIGHT = ML_ALIGN_BOTTOM }
	テキストの表示位置を決定します。 [詳細]
enum	ML_Encoding { ML_ENCODING_UCS4, ML_ENCODING_UTF16, ML_ENCODING_UTF8 }
	文字エンコーディングタイプを決定します。 [詳細]
関数
ALICEMLAPI void *ALICEMLCALL	ML_Malloc (ML_size size)
	メモリを確保します。
ALICEMLAPI void ALICEMLCALL	ML_Free (void *ptr)
	メモリを解放します。
ALICEMLAPI void *ALICEMLCALL	ML_PooledMalloc (ML_size size)
	プールされたメモリの確保を行います。
ALICEMLAPI void ALICEMLCALL	ML_PooledFree (void *ptr)
	プールメモリに使用済みのメモリを返します。
ALICEMLAPI ML_Message *ALICEMLCALL	ML_CreateMessage (ML_Backend *backend, int width, int height)
	メッセージレイヤオブジェクトを作成します。
ALICEMLAPI ML_Message *ALICEMLCALL	ML_CreateMessageFromSurface (ML_Surface *surface, ML_bool share_surface)
	サーフェイスからメッセージオブジェクトを作成します。
ALICEMLAPI void ALICEMLCALL	ML_DestroyMessage (ML_Message *message)
	メッセージレイヤオブジェクトを破棄します。
ALICEMLAPI ML_Surface *ALICEMLCALL	ML_CreateSurfaceFromBackend (ML_Backend *backend, void *abstract_surface)
	サーフェイスオブジェクトをバックエンドから作成します。
ALICEMLAPI void ALICEMLCALL	ML_DestroySurface (ML_Surface *surface)
	サーフェイスを破棄します。
ALICEMLAPI void *ALICEMLCALL	ML_GetAbstractSurface (ML_Surface *surface)
	バックエンド固有のサーフェイスを取得します。
ALICEMLAPI void ALICEMLCALL	ML_SetPrivateData (ML_Message *message, void *data)
	メッセージオブジェクトにユーザー固有のデータをバインドします。
ALICEMLAPI void *ALICEMLCALL	ML_GetPrivateData (ML_Message *message)
	メッセージオブジェクトにバインドされたユーザー固有のデータを取得します。
ALICEMLAPI int ALICEMLCALL	ML_Enable (ML_Message *message, ML_BoolIdentifier id)
	idで示される状態を有効にします。
ALICEMLAPI int ALICEMLCALL	ML_Disable (ML_Message *message, ML_BoolIdentifier id)
	idで示される状態を無効にします。
ALICEMLAPI int ALICEMLCALL	ML_SetBool (ML_Message *message, ML_BoolIdentifier id, ML_bool value)
	idで示される状態を変更します。
ALICEMLAPI ML_bool ALICEMLCALL	ML_IsEnabled (ML_Message *message, ML_BoolIdentifier id)
	idで示される状態が有効であるかを取得します。
ALICEMLAPI ML_bool ALICEMLCALL	ML_IsDisabled (ML_Message *message, ML_BoolIdentifier id)
	idで示される状態が無効であるかを取得します。
ALICEMLAPI int ALICEMLCALL	ML_SetInteger (ML_Message *message, ML_IntIdentifier id, int value)
	idで示される値に整数値を設定します。
ALICEMLAPI int ALICEMLCALL	ML_GetInteger (ML_Message *message, ML_IntIdentifier id, int *value)
	idで示される値を取得します。
ALICEMLAPI int ALICEMLCALL	ML_PushContext (ML_Message *message)
	オブジェクトの状態の保存を行います。
ALICEMLAPI int ALICEMLCALL	ML_PopContext (ML_Message *message)
	以前のオブジェクトの状態を復元します。
ALICEMLAPI int ALICEMLCALL	ML_PushFont (ML_Message *message)
	現在のフォントを保存します。
ALICEMLAPI int ALICEMLCALL	ML_PopFont (ML_Message *message)
	以前のフォントを復元します。
ALICEMLAPI int ALICEMLCALL	ML_SetMode (ML_Message *message, ML_Mode mode)
	モードを設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetAutoModeWait (ML_Message *message, int newline_wait, int newpage_wait, int pause_wait)
	オートモードの時間設定をします。
ALICEMLAPI int ALICEMLCALL	ML_SetNextCharTime (ML_Message *message, int next_char_time)
	文字ごとの表示時間などをまとめて設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetTextShowTime (ML_Message *message, int char_showing_time, int char_show_time, int char_hiding_time)
	文字のフェードイン／フェードアウトの時間を設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetLineStyle (ML_Message *message, ML_TextAlign align, int line_space, int char_space)
	行に関する設定を行います。
ALICEMLAPI int ALICEMLCALL	ML_SetDefaultFontFace (ML_Message *message, int index)
	フォントファイル名をデフォルト値に設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetFontFaceFromStr (ML_Message *message, const char *font_name, int index, ML_bool add_fontpath)
	フォントファイルを読み込み設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetFontFaceFromString (ML_Message *message, ML_String8 *font_name, int index, ML_bool add_fontpath)
	フォントファイルを読み込み設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetFontSize (ML_Message *message, int size)
	フォントサイズを設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetFontStyle (ML_Message *message, ML_FontStyle style)
	フォントスタイルを設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetFontColor (ML_Message *message, ML_Color color)
	フォントの色を設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetShadowColor (ML_Message *message, ML_Color color)
	フォントの影を設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetShadowOffset (ML_Message *message, int offset_x, int offset_y)
	フォントの影のオフセット値を設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetHemmingColor (ML_Message *message, ML_Color color)
	フォントの縁取りを設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetHemmingWidth (ML_Message *message, int width_x, int width_y)
	フォントの縁取りの太さを決定します。
ALICEMLAPI int ALICEMLCALL	ML_SetRubyStyle (ML_Message *message, int ruby_size, int ruby_offset)
	ルビ文字に関する設定を行います。
ALICEMLAPI int ALICEMLCALL	ML_SetPosition (ML_Message *message, int left, int top)
	ウィンドウの基準位置を設定します。
ALICEMLAPI int ALICEMLCALL	ML_GetSize (ML_Message *message, int *width, int *height)
	ウィンドウのサイズを取得します。
ALICEMLAPI int ALICEMLCALL	ML_SetSize (ML_Message *message, int width, int height)
	ウィンドウのサイズを設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetBounds (ML_Message *message, int left, int top, int width, int height)
	ウィンドウの境界を設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetMargin (ML_Message *message, int marginl, int margint, int marginr, int marginb)
	ウィンドウのマージン幅を設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetCallbackText (ML_Message *message, ML_Callback_Text callback)
	ページ終了時にそのとき画面に表示されていたテキストを得るための関数を設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetCodeConverter (ML_Message *message, ML_CodeConverter *converter)
	文字エンコーダーを設定します。
ALICEMLAPI int ALICEMLCALL	ML_SetEncoding (ML_Message *message, ML_Encoding encoding)
	文字エンコーディングタイプを設定します。
ALICEMLAPI int ALICEMLCALL	ML_Update (ML_Message *message, int dt)
	メッセージレイヤ上の時間を進めます。
ALICEMLAPI int ALICEMLCALL	ML_Refresh (ML_Message *message)
	メッセージレイヤ情報を更新します。主に内部で使います。
ALICEMLAPI int ALICEMLCALL	ML_NextPage (ML_Message *message)
	ページを次に進めます。
ALICEMLAPI int ALICEMLCALL	ML_PrevPage (ML_Message *message)
	ページを一つ戻します。
ALICEMLAPI int ALICEMLCALL	ML_SetLastPage (ML_Message *message)
	一番最後のページに設定します。
ALICEMLAPI int ALICEMLCALL	ML_Background (ML_Message *message, int dt, ML_bool is_sleep)
	余った時間で文字サーフェイスの先読みなどを行います。
ALICEMLAPI int ALICEMLCALL	ML_GoNext (ML_Message *message)
	再開します。
ALICEMLAPI int ALICEMLCALL	ML_DrawText (ML_Message *message, ML_Surface *target)
	ウィンドウ上にメッセージを描画します。
ALICEMLAPI int ALICEMLCALL	ML_BeginBatch (ML_Message *message)
	連続した文字の追加で高速に行えるようになります。
ALICEMLAPI int ALICEMLCALL	ML_EndBatch (ML_Message *message)
	連続した文字の追加を終了します。
ALICEMLAPI int ALICEMLCALL	ML_AddChar32 (ML_Message *message, ML_char32 c)
	文字を追加します。
ALICEMLAPI int ALICEMLCALL	ML_AddChar16 (ML_Message *message, ML_char16 c)
ALICEMLAPI int ALICEMLCALL	ML_AddChar8 (ML_Message *message, ML_char8 c)
ALICEMLAPI int ALICEMLCALL	ML_AddTextl32 (ML_Message *message, const ML_char32 *text, ML_size length)
	表示テキストを追加します。
ALICEMLAPI int ALICEMLCALL	ML_AddTextl16 (ML_Message *message, const ML_char16 *text, ML_size length)
ALICEMLAPI int ALICEMLCALL	ML_AddTextl8 (ML_Message *message, const ML_char8 *text, ML_size length)
ALICEMLAPI int ALICEMLCALL	ML_AddText32 (ML_Message *message, const ML_char32 *text)
	表示テキストを追加します。
ALICEMLAPI int ALICEMLCALL	ML_AddText16 (ML_Message *message, const ML_char16 *text)
ALICEMLAPI int ALICEMLCALL	ML_AddText8 (ML_Message *message, const ML_char8 *text)
ALICEMLAPI int ALICEMLCALL	ML_AddLinkl32 (ML_Message *message, const ML_char32 *text, ML_size length, int id)
	リンクテキストを文字の長さを指定して追加します。
ALICEMLAPI int ALICEMLCALL	ML_AddLinkl16 (ML_Message *message, const ML_char16 *text, ML_size length, int id)
ALICEMLAPI int ALICEMLCALL	ML_AddLinkl8 (ML_Message *message, const ML_char8 *text, ML_size length, int id)
ALICEMLAPI int ALICEMLCALL	ML_AddLink32 (ML_Message *message, const ML_char32 *text, int id)
	リンクテキストを追加します。
ALICEMLAPI int ALICEMLCALL	ML_AddLink16 (ML_Message *message, const ML_char16 *text, int id)
ALICEMLAPI int ALICEMLCALL	ML_AddLink8 (ML_Message *message, const ML_char8 *text, int id)
ALICEMLAPI int ALICEMLCALL	ML_AddTextWithRuby32 (ML_Message *message, const ML_char32 *text, const ML_char32 *reading)
	テキストをルビ文字付きで追加します。
ALICEMLAPI int ALICEMLCALL	ML_AddTextWithRuby16 (ML_Message *message, const ML_char16 *text, const ML_char16 *reading)
ALICEMLAPI int ALICEMLCALL	ML_AddTextWithRuby8 (ML_Message *message, const ML_char8 *text, const ML_char8 *reading)
ALICEMLAPI int ALICEMLCALL	ML_AddCommand (ML_Message *message, ML_Command *command)
	縦書き中に横書き文字を書きます。
ALICEMLAPI int ALICEMLCALL	ML_AddNewLine (ML_Message *message)
	改行します。
ALICEMLAPI int ALICEMLCALL	ML_AddNewPage (ML_Message *message)
	改ページを行います。
ALICEMLAPI int ALICEMLCALL	ML_AddPause (ML_Message *message)
	クリック待ちなどのために一旦停止します。
ALICEMLAPI int ALICEMLCALL	ML_AddWait (ML_Message *message, int time)
	ウェイト指定を入れます。
ALICEMLAPI int ALICEMLCALL	ML_CopyText (ML_Message *from, ML_Message *to)
	テキスト内容すべてをコピーします。
ALICEMLAPI int ALICEMLCALL	ML_MakeHistory (ML_Message *from, ML_Message *to)
	表示し終わったコマンドを他のオブジェクトに移します。
ALICEMLAPI ML_bool ALICEMLCALL	ML_IsEnd (ML_Message *message)
	すべてのコマンドが終了しているか調べます。
ALICEMLAPI int ALICEMLCALL	ML_Clear (ML_Message *message)
	登録されたコマンドをすべて破棄します。
ALICEMLAPI ML_bool ALICEMLCALL	ML_IsCurrentFull (ML_Message *message)
	コマンドがいっぱいまで入っているか調べます。
ALICEMLAPI ML_bool ALICEMLCALL	ML_IsCurrentEmpty (ML_Message *message)
	実行中のコマンドが無いかどうかを取得します。
ALICEMLAPI void ALICEMLCALL	ML_DumpCommands (ML_Message *message, FILE *fp, ML_bool only_current)
	コマンド列の中身をダンプします(デバッグ用)。
ALICEMLAPI int ALICEMLCALL	ML_AddAvoidRect (ML_Message *message, ML_Rect *rect)
	テキスト描画時に回避する矩形を追加してください。
ALICEMLAPI int ALICEMLCALL	ML_GetAvoidRectSize (ML_Message *message)
	回避矩形の数を取得します。
ALICEMLAPI ML_Rect *ALICEMLCALL	ML_GetAvoidRect (ML_Message *message, int i)
	回避矩形を取得します。
ALICEMLAPI void ALICEMLCALL	ML_ClearAvoidRect (ML_Message *message)
	回避矩形をすべて破棄します。
ALICEMLAPI int ALICEMLCALL	ML_AddDirtyRect (ML_Message *message, const ML_Rect *rect)
	更新矩形を追加します。ML_Update と ML_DrawText の間に呼び出してください。
ALICEMLAPI int ALICEMLCALL	ML_GetDirtyRectSize (ML_Message *message)
	更新矩形の数を取得します。
ALICEMLAPI ML_Rect *ALICEMLCALL	ML_GetDirtyRect (ML_Message *message, int i)
	更新矩形を取得します。
ALICEMLAPI ML_bool ALICEMLCALL	ML_IntersectDirtyRect (ML_Message *message, ML_Rect *rect)
	更新矩形と交差する矩形領域を取得します。
ALICEMLAPI int ALICEMLCALL	ML_GetLinkID (ML_Message *message, int x, int y)
	その座標を含むリンクがあればそれのＩＤを返します。
ALICEMLAPI void ALICEMLCALL	ML_SetError (const char *format,...)
	エラー文字列を設定します。
ALICEMLAPI const char *ALICEMLCALL	ML_GetError ()
	エラー文字列を取得します。
ALICEMLAPI void ALICEMLCALL	ML_ClearError ()
	エラー文字列をクリアします。
ALICEMLAPI int ALICEMLCALL	ML_CheckMemory ()
	確保されて、まだ解放されていないメモリがあるかどうかを調べます。
ALICEMLAPI ML_String8 *ALICEMLCALL	ML_MakeFontPath (const ML_char8 *fontfile)
	フォントファイル名から、フォントのフルパスを取得します。
ALICEMLAPI ML_String8 *ALICEMLCALL	ML_GetDefaultFont ()
	デフォルトのフォントファイルパスを取得します。
ALICEMLAPI ML_uint32 ALICEMLCALL	ML_GetTicks ()
	現在時刻を得ます。
ALICEMLAPI int ALICEMLCALL	ML_Delay (ML_uint32 time)
	指定されたミリ秒だけ、プログラムを止めます。

---

マクロ定義

#define ML_ABS

(

x

)

((x) >= 0 ? (x) : -(x))

絶対値を取得します。

#define ML_AddCharWChar   ML_AddChar16

#define ML_AddLinklWChar   ML_AddLinkl16

#define ML_AddLinkWChar   ML_AddLink16

#define ML_AddTextlWChar   ML_AddTextl16

#define ML_AddTextWChar   ML_AddText16

#define ML_AddTextWithRubyWChar   ML_AddTextWithRuby16

#define ML_FONTSTYLE_BOLD   0x0001

イタリック体です。

#define ML_FONTSTYLE_HEMMING   0x0200

袋文字にします。

#define ML_FONTSTYLE_ITALIC   0x0002

#define ML_FONTSTYLE_REGULAR   0x0000

太文字です。

#define ML_FONTSTYLE_SHADOW   0x0100

文字に影をつけます。

#define ML_FONTSTYLE_SIMPLEMASK   0x00ff

ML_SimpleFontに使われるフラグのマスクです。

#define ML_FONTSTYLE_UNDERLINE   0x0004

下線を引きます。

#define ML_FONTSTYLE_VERTICAL   0x0008

縦書き文字にします。

#define ML_FREE

(

PTR

)

ML_Free(PTR)

メモリを解放します。

#define ML_FREE2

(

PTR

)

ML_Free(PTR)

一応作っておきます。

#define ML_GetBool   ML_IsEnabled

idで示される状態が有効であるかを取得します。

#define ML_HAS_FLAG	(	var,
		flag		)	((ML_bool)(((var) & (flag)) != 0))

var が特定のフラグをもっているか調べます。

#define ML_MAX	(	x,
		y		)	((x) > (y) ? (x) : (y))

大きい方の値を取得します。

#define ML_MEDIAN	(	x,
		min_value,
		max_value		)	ML_MIN((max_value), ML_MAX((min_value), (x)))

３つの値の中間値を取得します。

#define ML_MIN	(	x,
		y		)	((x) < (y) ? (x) : (y))

小さい方の値を取得します。

#define ML_NEW

(

TYPE

)

(TYPE *)ML_Malloc(sizeof(TYPE))

メモリを確保します。

#define ML_NEW2	(	TYPE,
		NUM		)	(TYPE *)ML_Malloc(sizeof(TYPE) * (NUM))

複数のオブジェクトのメモリを確保します。

---

型定義

typedef struct ML_Backend ML_Backend

typedef void(ALICEMLCALL * ML_Callback)(ML_Message *message)

種々の変更をユーザーに通知します。

typedef int(ALICEMLCALL * ML_Callback_Insert)(void *elem)

オブジェクトの挿入時に呼び出される関数型です。

typedef void(ALICEMLCALL * ML_Callback_Remove)(void *elem)

オブジェクトの削除時に呼び出される関数型です。

typedef void(ALICEMLCALL * ML_Callback_Text)(ML_Message *message, ML_bool newpage)

表示が終わったコマンドをユーザーに通知します。

typedef struct ML_CodeConverter ML_CodeConverter

typedef struct ML_Command ML_Command

typedef int(ALICEMLCALL * ML_Comparator)(const void *elem1, const void *elem2)

オブジェクトを比較するときに呼ばれる関数型です。

typedef struct ML_Font ML_Font

typedef int ML_FontStyle

フォントスタイルです。or演算で複数を指定できます。

enumだと＆演算や｜演算がイリーガルなものとなるので、 int型として定義しています。 文字の装飾を行いません。

typedef struct ML_Message ML_Message

typedef struct ML_Surface ML_Surface

---

列挙型

enum ML_BoolIdentifier

ML_Messageの状態値を有効／無効にするときに使います。

列挙型の値:

ML_VERTICAL	縦書きかどうかです。
ML_CONTINUE_TO_PAUSE	クリックによりページ末まで一気に表示させるかどうかです。
ML_WAIT	時間制限付きのウェイトを有効にするかです。
ML_PAUSE	クリック待ちのウェイトを有効にするかどうかです。
ML_AUTO_NEWLINE	表示領域を超える場合は自動的に改行します。
ML_AUTO_NEWPAGE	ページ末まで表示されたら自動的に改ページを入れるかどうかです。
ML_CHAR_AUTO_HIDE	文字を時間制限付きで消すかどうかです。
ML_CHAR_SHOWING	文字をフェードインで表示するかどうかです。
ML_CHAR_HIDING	文字をフェードアウトで消すかどうかです。
ML_AUTO_REFRESH	コマンド追加時に自動的に表示文字列を変更するかどうかです。
ML_TAG_MODE	追加される文字の一部がタグとして認識します。

enum ML_Encoding

文字エンコーディングタイプを決定します。

列挙型の値:

ML_ENCODING_UCS4
ML_ENCODING_UTF16
ML_ENCODING_UTF8

enum ML_IntIdentifier

ML_Messageの状態値を変更または取得する時に使います。

列挙型の値:

ML_AUTOMODE_NEWLINE_WAIT	自動読み進みモード時の改行の待ち時間です。
ML_AUTOMODE_NEWPAGE_WAIT	自動読み進みモード時の改ページの待ち時間です。
ML_AUTOMODE_PAUSE_WAIT	自動読み進みモード時のクリック待ち時間です。
ML_TEXT_ALIGN	テキストアラインです。
ML_LINE_SPACE	行間です。
ML_CHAR_SPACE	文字間です。
ML_FONT_SIZE	フォントサイズです。
ML_FONT_STYLE	フォントスタイルです。
ML_RUBY_SIZE	ルビ文字の大きさです。
ML_RUBY_OFFSET	ルビ文字のオフセットです。
ML_TEXT_SPEED	文字が表示されてから次の文字が表示されるまでの時間です。
ML_CHAR_SHOW_TIME	文字が表示されている時間です。
ML_CHAR_SHOWING_TIME	文字がフェードインするのに必要な時間です。
ML_CHAR_HIDING_TIME	文字がフェードアウトするのに必要な時間です。

enum ML_Mode

メッセージレイヤのモードを示します。

列挙型の値:

ML_MODE_NORMAL	通常のクリックで先に進むモードです。
ML_MODE_AUTO	何もしなくても自動的に先へ進むモードです。
ML_MODE_SKIP	１フレームテキストを表示してすぐに先へ進むモードです。
ML_MODE_SUSPEND	まったく先へ進めなくなります。

enum ML_TextAlign

テキストの表示位置を決定します。

列挙型の値:

ML_ALIGN_NORMAL	通常の文字配置です。
ML_ALIGN_TOP	横書き状態で、文字の最上辺を行の一番上に合わせます。
ML_ALIGN_BOTTOM	横書き状態で、文字の底辺を行の一番上に合わせます。
ML_ALIGN_LEFT	縦書き状態で、文字の左辺を行の一番左に合わせます。
ML_ALIGN_RIGHT	縦書き状態で、文字の右辺を行の一番右に合わせます。

---

関数

ALICEMLAPI int ALICEMLCALL ML_AddAvoidRect	(	ML_Message *	message,
		ML_Rect *	rect
	)

テキスト描画時に回避する矩形を追加してください。

ALICEMLAPI int ALICEMLCALL ML_AddChar16	(	ML_Message *	message,
		ML_char16	c
	)

ALICEMLAPI int ALICEMLCALL ML_AddChar32	(	ML_Message *	message,
		ML_char32	c
	)

文字を追加します。

ALICEMLAPI int ALICEMLCALL ML_AddChar8	(	ML_Message *	message,
		ML_char8	c
	)

ALICEMLAPI int ALICEMLCALL ML_AddCommand	(	ML_Message *	message,
		ML_Command *	command
	)

縦書き中に横書き文字を書きます。

直接コマンドを挿入します。

ALICEMLAPI int ALICEMLCALL ML_AddDirtyRect	(	ML_Message *	message,
		const ML_Rect *	rect
	)

更新矩形を追加します。ML_Update と ML_DrawText の間に呼び出してください。

ALICEMLAPI int ALICEMLCALL ML_AddLink16	(	ML_Message *	message,
		const ML_char16 *	text,
		int	id
	)

ALICEMLAPI int ALICEMLCALL ML_AddLink32	(	ML_Message *	message,
		const ML_char32 *	text,
		int	id
	)

リンクテキストを追加します。

ALICEMLAPI int ALICEMLCALL ML_AddLink8	(	ML_Message *	message,
		const ML_char8 *	text,
		int	id
	)

ALICEMLAPI int ALICEMLCALL ML_AddLinkl16	(	ML_Message *	message,
		const ML_char16 *	text,
		ML_size	length,
		int	id
	)

ALICEMLAPI int ALICEMLCALL ML_AddLinkl32	(	ML_Message *	message,
		const ML_char32 *	text,
		ML_size	length,
		int	id
	)

リンクテキストを文字の長さを指定して追加します。

ALICEMLAPI int ALICEMLCALL ML_AddLinkl8	(	ML_Message *	message,
		const ML_char8 *	text,
		ML_size	length,
		int	id
	)

ALICEMLAPI int ALICEMLCALL ML_AddNewLine

(

ML_Message *

message

)

改行します。

ALICEMLAPI int ALICEMLCALL ML_AddNewPage

(

ML_Message *

message

)

改ページを行います。

ALICEMLAPI int ALICEMLCALL ML_AddPause

(

ML_Message *

message

)

クリック待ちなどのために一旦停止します。

ALICEMLAPI int ALICEMLCALL ML_AddText16	(	ML_Message *	message,
		const ML_char16 *	text
	)

ALICEMLAPI int ALICEMLCALL ML_AddText32	(	ML_Message *	message,
		const ML_char32 *	text
	)

表示テキストを追加します。

ALICEMLAPI int ALICEMLCALL ML_AddText8	(	ML_Message *	message,
		const ML_char8 *	text
	)

ALICEMLAPI int ALICEMLCALL ML_AddTextl16	(	ML_Message *	message,
		const ML_char16 *	text,
		ML_size	length
	)

ALICEMLAPI int ALICEMLCALL ML_AddTextl32	(	ML_Message *	message,
		const ML_char32 *	text,
		ML_size	length
	)

表示テキストを追加します。

ALICEMLAPI int ALICEMLCALL ML_AddTextl8	(	ML_Message *	message,
		const ML_char8 *	text,
		ML_size	length
	)

ALICEMLAPI int ALICEMLCALL ML_AddTextWithRuby16	(	ML_Message *	message,
		const ML_char16 *	text,
		const ML_char16 *	reading
	)

ALICEMLAPI int ALICEMLCALL ML_AddTextWithRuby32	(	ML_Message *	message,
		const ML_char32 *	text,
		const ML_char32 *	reading
	)

テキストをルビ文字付きで追加します。

ALICEMLAPI int ALICEMLCALL ML_AddTextWithRuby8	(	ML_Message *	message,
		const ML_char8 *	text,
		const ML_char8 *	reading
	)

ALICEMLAPI int ALICEMLCALL ML_AddWait	(	ML_Message *	message,
		int	time
	)

ウェイト指定を入れます。

ALICEMLAPI int ALICEMLCALL ML_Background	(	ML_Message *	message,
		int	dt,
		ML_bool	is_sleep
	)

余った時間で文字サーフェイスの先読みなどを行います。

ALICEMLAPI int ALICEMLCALL ML_BeginBatch

(

ML_Message *

message

)

連続した文字の追加で高速に行えるようになります。

ALICEMLAPI int ALICEMLCALL ML_CheckMemory

(

)

確保されて、まだ解放されていないメモリがあるかどうかを調べます。

ALICEMLAPI int ALICEMLCALL ML_Clear

(

ML_Message *

message

)

登録されたコマンドをすべて破棄します。

ALICEMLAPI void ALICEMLCALL ML_ClearAvoidRect

(

ML_Message *

message

)

回避矩形をすべて破棄します。

ALICEMLAPI void ALICEMLCALL ML_ClearError

(

)

エラー文字列をクリアします。

ALICEMLAPI int ALICEMLCALL ML_CopyText	(	ML_Message *	from,
		ML_Message *	to
	)

テキスト内容すべてをコピーします。

ALICEMLAPI ML_Message* ALICEMLCALL ML_CreateMessage	(	ML_Backend *	backend,
		int	width,
		int	height
	)

メッセージレイヤオブジェクトを作成します。

ALICEMLAPI ML_Message* ALICEMLCALL ML_CreateMessageFromSurface	(	ML_Surface *	surface,
		ML_bool	share_surface
	)

サーフェイスからメッセージオブジェクトを作成します。

ALICEMLAPI ML_Surface* ALICEMLCALL ML_CreateSurfaceFromBackend	(	ML_Backend *	backend,
		void *	abstract_surface
	)

サーフェイスオブジェクトをバックエンドから作成します。

ALICEMLAPI int ALICEMLCALL ML_Delay

(

ML_uint32

time

)

指定されたミリ秒だけ、プログラムを止めます。

ALICEMLAPI void ALICEMLCALL ML_DestroyMessage

(

ML_Message *

message

)

メッセージレイヤオブジェクトを破棄します。

ALICEMLAPI void ALICEMLCALL ML_DestroySurface

(

ML_Surface *

surface

)

サーフェイスを破棄します。

ALICEMLAPI int ALICEMLCALL ML_Disable	(	ML_Message *	message,
		ML_BoolIdentifier	id
	)

idで示される状態を無効にします。

ALICEMLAPI int ALICEMLCALL ML_DrawText	(	ML_Message *	message,
		ML_Surface *	target
	)

ウィンドウ上にメッセージを描画します。

ALICEMLAPI void ALICEMLCALL ML_DumpCommands	(	ML_Message *	message,
		FILE *	fp,
		ML_bool	only_current
	)

コマンド列の中身をダンプします(デバッグ用)。

ALICEMLAPI int ALICEMLCALL ML_Enable	(	ML_Message *	message,
		ML_BoolIdentifier	id
	)

idで示される状態を有効にします。

ALICEMLAPI int ALICEMLCALL ML_EndBatch

(

ML_Message *

message

)

連続した文字の追加を終了します。

ALICEMLAPI void ALICEMLCALL ML_Free

(

void *

ptr

)

メモリを解放します。

ALICEMLAPI void* ALICEMLCALL ML_GetAbstractSurface

(

ML_Surface *

surface

)

バックエンド固有のサーフェイスを取得します。

ALICEMLAPI ML_Rect* ALICEMLCALL ML_GetAvoidRect	(	ML_Message *	message,
		int	i
	)

回避矩形を取得します。

ALICEMLAPI int ALICEMLCALL ML_GetAvoidRectSize

(

ML_Message *

message

)

回避矩形の数を取得します。

ALICEMLAPI ML_String8* ALICEMLCALL ML_GetDefaultFont

(

)

デフォルトのフォントファイルパスを取得します。

ALICEMLAPI ML_Rect* ALICEMLCALL ML_GetDirtyRect	(	ML_Message *	message,
		int	i
	)

更新矩形を取得します。

ALICEMLAPI int ALICEMLCALL ML_GetDirtyRectSize

(

ML_Message *

message

)

更新矩形の数を取得します。

ALICEMLAPI const char* ALICEMLCALL ML_GetError

(

)

エラー文字列を取得します。

ALICEMLAPI int ALICEMLCALL ML_GetInteger	(	ML_Message *	message,
		ML_IntIdentifier	id,
		int *	value
	)

idで示される値を取得します。

ALICEMLAPI int ALICEMLCALL ML_GetLinkID	(	ML_Message *	message,
		int	x,
		int	y
	)

その座標を含むリンクがあればそれのＩＤを返します。

ALICEMLAPI void* ALICEMLCALL ML_GetPrivateData

(

ML_Message *

message

)

メッセージオブジェクトにバインドされたユーザー固有のデータを取得します。

ALICEMLAPI int ALICEMLCALL ML_GetSize	(	ML_Message *	message,
		int *	width,
		int *	height
	)

ウィンドウのサイズを取得します。

ALICEMLAPI ML_uint32 ALICEMLCALL ML_GetTicks

(

)

現在時刻を得ます。

ALICEMLAPI int ALICEMLCALL ML_GoNext

(

ML_Message *

message

)

再開します。

ALICEMLAPI ML_bool ALICEMLCALL ML_IntersectDirtyRect	(	ML_Message *	message,
		ML_Rect *	rect
	)

更新矩形と交差する矩形領域を取得します。

ALICEMLAPI ML_bool ALICEMLCALL ML_IsCurrentEmpty

(

ML_Message *

message

)

実行中のコマンドが無いかどうかを取得します。

ALICEMLAPI ML_bool ALICEMLCALL ML_IsCurrentFull

(

ML_Message *

message

)

コマンドがいっぱいまで入っているか調べます。

ALICEMLAPI ML_bool ALICEMLCALL ML_IsDisabled	(	ML_Message *	message,
		ML_BoolIdentifier	id
	)

idで示される状態が無効であるかを取得します。

ALICEMLAPI ML_bool ALICEMLCALL ML_IsEnabled	(	ML_Message *	message,
		ML_BoolIdentifier	id
	)

idで示される状態が有効であるかを取得します。

ALICEMLAPI ML_bool ALICEMLCALL ML_IsEnd

(

ML_Message *

message

)

すべてのコマンドが終了しているか調べます。

ALICEMLAPI ML_String8* ALICEMLCALL ML_MakeFontPath

(

const ML_char8 *

fontfile

)

フォントファイル名から、フォントのフルパスを取得します。

環境依存するフォントファイル名からフルパス名を取得します。

ALICEMLAPI int ALICEMLCALL ML_MakeHistory	(	ML_Message *	from,
		ML_Message *	to
	)

表示し終わったコマンドを他のオブジェクトに移します。

ALICEMLAPI void* ALICEMLCALL ML_Malloc

(

ML_size

size

)

メモリを確保します。

ALICEMLAPI int ALICEMLCALL ML_NextPage

(

ML_Message *

message

)

ページを次に進めます。

ALICEMLAPI void ALICEMLCALL ML_PooledFree

(

void *

ptr

)

プールメモリに使用済みのメモリを返します。

ALICEMLAPI void* ALICEMLCALL ML_PooledMalloc

(

ML_size

size

)

プールされたメモリの確保を行います。

ALICEMLAPI int ALICEMLCALL ML_PopContext

(

ML_Message *

message

)

以前のオブジェクトの状態を復元します。

ALICEMLAPI int ALICEMLCALL ML_PopFont

(

ML_Message *

message

)

以前のフォントを復元します。

ALICEMLAPI int ALICEMLCALL ML_PrevPage

(

ML_Message *

message

)

ページを一つ戻します。

ALICEMLAPI int ALICEMLCALL ML_PushContext

(

ML_Message *

message

)

オブジェクトの状態の保存を行います。

ALICEMLAPI int ALICEMLCALL ML_PushFont

(

ML_Message *

message

)

現在のフォントを保存します。

ALICEMLAPI int ALICEMLCALL ML_Refresh

(

ML_Message *

message

)

メッセージレイヤ情報を更新します。主に内部で使います。

ALICEMLAPI int ALICEMLCALL ML_SetAutoModeWait	(	ML_Message *	message,
		int	newline_wait,
		int	newpage_wait,
		int	pause_wait
	)

オートモードの時間設定をします。

ALICEMLAPI int ALICEMLCALL ML_SetBool	(	ML_Message *	message,
		ML_BoolIdentifier	id,
		ML_bool	value
	)

idで示される状態を変更します。

ALICEMLAPI int ALICEMLCALL ML_SetBounds	(	ML_Message *	message,
		int	left,
		int	top,
		int	width,
		int	height
	)

ウィンドウの境界を設定します。

ALICEMLAPI int ALICEMLCALL ML_SetCallbackText	(	ML_Message *	message,
		ML_Callback_Text	callback
	)

ページ終了時にそのとき画面に表示されていたテキストを得るための関数を設定します。

ALICEMLAPI int ALICEMLCALL ML_SetCodeConverter	(	ML_Message *	message,
		ML_CodeConverter *	converter
	)

文字エンコーダーを設定します。

ALICEMLAPI int ALICEMLCALL ML_SetDefaultFontFace	(	ML_Message *	message,
		int	index
	)

フォントファイル名をデフォルト値に設定します。

ALICEMLAPI int ALICEMLCALL ML_SetEncoding	(	ML_Message *	message,
		ML_Encoding	encoding
	)

文字エンコーディングタイプを設定します。

ALICEMLAPI void ALICEMLCALL ML_SetError	(	const char *	format,
			...
	)

エラー文字列を設定します。

ALICEMLAPI int ALICEMLCALL ML_SetFontColor	(	ML_Message *	message,
		ML_Color	color
	)

フォントの色を設定します。

ALICEMLAPI int ALICEMLCALL ML_SetFontFaceFromStr	(	ML_Message *	message,
		const char *	font_name,
		int	index,
		ML_bool	add_fontpath
	)

フォントファイルを読み込み設定します。

ALICEMLAPI int ALICEMLCALL ML_SetFontFaceFromString	(	ML_Message *	message,
		ML_String8 *	font_name,
		int	index,
		ML_bool	add_fontpath
	)

フォントファイルを読み込み設定します。

ALICEMLAPI int ALICEMLCALL ML_SetFontSize	(	ML_Message *	message,
		int	size
	)

フォントサイズを設定します。

ALICEMLAPI int ALICEMLCALL ML_SetFontStyle	(	ML_Message *	message,
		ML_FontStyle	style
	)

フォントスタイルを設定します。

ALICEMLAPI int ALICEMLCALL ML_SetHemmingColor	(	ML_Message *	message,
		ML_Color	color
	)

フォントの縁取りを設定します。

ALICEMLAPI int ALICEMLCALL ML_SetHemmingWidth	(	ML_Message *	message,
		int	width_x,
		int	width_y
	)

フォントの縁取りの太さを決定します。

ALICEMLAPI int ALICEMLCALL ML_SetInteger	(	ML_Message *	message,
		ML_IntIdentifier	id,
		int	value
	)

idで示される値に整数値を設定します。

ALICEMLAPI int ALICEMLCALL ML_SetLastPage

(

ML_Message *

message

)

一番最後のページに設定します。

ALICEMLAPI int ALICEMLCALL ML_SetLineStyle	(	ML_Message *	message,
		ML_TextAlign	align,
		int	line_space,
		int	char_space
	)

行に関する設定を行います。

ALICEMLAPI int ALICEMLCALL ML_SetMargin	(	ML_Message *	message,
		int	marginl,
		int	margint,
		int	marginr,
		int	marginb
	)

ウィンドウのマージン幅を設定します。

ALICEMLAPI int ALICEMLCALL ML_SetMode	(	ML_Message *	message,
		ML_Mode	mode
	)

モードを設定します。

ALICEMLAPI int ALICEMLCALL ML_SetNextCharTime	(	ML_Message *	message,
		int	next_char_time
	)

文字ごとの表示時間などをまとめて設定します。

ALICEMLAPI int ALICEMLCALL ML_SetPosition	(	ML_Message *	message,
		int	left,
		int	top
	)

ウィンドウの基準位置を設定します。

ALICEMLAPI void ALICEMLCALL ML_SetPrivateData	(	ML_Message *	message,
		void *	data
	)

メッセージオブジェクトにユーザー固有のデータをバインドします。

ALICEMLAPI int ALICEMLCALL ML_SetRubyStyle	(	ML_Message *	message,
		int	ruby_size,
		int	ruby_offset
	)

ルビ文字に関する設定を行います。

ALICEMLAPI int ALICEMLCALL ML_SetShadowColor	(	ML_Message *	message,
		ML_Color	color
	)

フォントの影を設定します。

ALICEMLAPI int ALICEMLCALL ML_SetShadowOffset	(	ML_Message *	message,
		int	offset_x,
		int	offset_y
	)

フォントの影のオフセット値を設定します。

ALICEMLAPI int ALICEMLCALL ML_SetSize	(	ML_Message *	message,
		int	width,
		int	height
	)

ウィンドウのサイズを設定します。

ALICEMLAPI int ALICEMLCALL ML_SetTextShowTime	(	ML_Message *	message,
		int	char_showing_time,
		int	char_show_time,
		int	char_hiding_time
	)

文字のフェードイン／フェードアウトの時間を設定します。

ALICEMLAPI int ALICEMLCALL ML_Update	(	ML_Message *	message,
		int	dt
	)

メッセージレイヤ上の時間を進めます。