目次 - SDL 3.0 API(機能別) - イベント処理 - SDL_GetEventDescription

SDL_GetEventDescription

イベントの人が読むことのできる記述を得る

ヘッダ

SDL3/SDL_events.h

構文

int SDL_GetEventDescription(const SDL_Event *event, char *buf, int buflen);

引数

const SDL_Event *event記述を得るイベント. NULLも可
char *buf記述の書き込み先のバッファへのポインタ. NULLも可
intbuflenbufに書き込める最大バイト数

戻り値

(int) 終端のNUL文字を含まない文字列全体のバイト数

詳細

これは次の様なNUL終端の文字列をbufに書き込む:

SDL_EVENT_MOUSE_MOTION (timestamp=1140256324 windowid=2 which=0 state=0 x=492.99 y=139.09 xrel=52 yrel=6)

実際の文字列の形式は保証されない. これはログを目的としていて, 人が読むものであり, コンピュータが構文解析するものではない.

戻される値はSDL_snprintf()と同じ規則で, bufには常にNUL終端が付き(buflenが0でない限り), buflenが短い場合は切り捨てられる. 戻り値は計算された必要なバイト数であり, 文字列が切り捨てられた場合もそうでない場合も, NUL終端まで数えた値ではない. よって, SDL_snprintf()とは違い, この関数が-1を戻すことはない.

スレッドセーフ

この関数はスレッドセーフである.

バージョン

SDL 3.4.0以降

関連項目

SDL Wikiへのリンク

SDL_GetEventDescription - SDL Wiki