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

SDL_StartTextInputWithProperties

プロパティを設定してウィンドウのUnicodeテキスト入力イベントの受け入れを開始する

ヘッダ

bool SDL_StartTextInputWithProperties(SDL_Window *window, SDL_PropertiesID props);

SDL_Window *	window	テキスト入力を有効化するウィンドウ
SDL_PropertiesID	props	the properties to use

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

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

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

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

次のプロパティに対応している:

SDL_PROP_TEXTINPUT_TYPE_NUMBER - テキスト入力の種類を表すSDL_TextInputTypeの値. デフォルトはSDL_TEXTINPUT_TYPE_TEXT
SDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER
- 入力テキストの大文字化の指定を表すSDL_Capitalizationの値. デフォルトは通常のテキスト入力の場合はSDL_CAPITALIZE_SENTENCES, SDL_TEXTINPUT_TYPE_TEXT_NAMEの場合はSDL_CAPITALIZE_WORDS, e-mailアドレス, ユーザ名, パスワードの場合はSDL_CAPITALIZE_NONE
SDL_PROP_TEXTINPUT_AUTOCORRECT_BOOLEAN
- 真のとき自動補完と自動修正が有効, デフォルトは真
SDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN
- 真のとき複数行の入力を認める. デフォルトは, SDL_HINT_RETURN_KEY_HIDES_IMEが"0"または設定されていないならば真, "1"ならば偽

Androidの場合, 入力の種類を直接指定できる:

SDL_PROP_TEXTINPUT_ANDROID_INPUTTYPE_NUMBER
- 使用するテキスト入力の種類. 他のプロパティを上書きする. 詳細はhttps://developer.android.com/reference/android/text/InputTypeを参照すること

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

SDL 3.2.0以降