int SDL_GetEventDescription(const SDL_Event *event, char *buf, int buflen);
const SDL_Event * | event | 記述を得るイベント. NULLも可 |
char * | buf | 記述の書き込み先のバッファへのポインタ. NULLも可 |
int | buflen | buf に書き込める最大バイト数 |
これは次の様な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を戻すことはない.
この関数はスレッドセーフである.