目次 - SDL 3.0 API(機能別) - キーボード - SDL_StartTextInput

SDL_StartTextInput

ウィンドウのUnicodeテキスト入力イベントの受け入れを開始する

ヘッダ

SDL3/SDL_keyboard.h

構文

bool SDL_StartTextInput(SDL_Window *window);

引数

SDL_Window *windowテキスト入力を有効化するウィンドウ

戻り値

(bool) 成功のとき真, 失敗のとき偽を戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

この関数は指定したウィンドウのテキスト入力(SDL_EVENT_TEXT_INPUTSDL_EVENT_TEXT_EDITINGイベント)を有効にする. この関数はSDL_StopTextInput()と対になっている.

テキスト入力イベントはデフォルトでは有効でない.

一部の環境では, この関数でスクリーンキーボードやIMEが表示され, ここでキーが押されることでキー押下イベントが阻害されることがある.

スレッドセーフ

この関数を呼べるのはメインスレッドのみである.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_StartTextInput - SDL Wiki