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

SDL_GetKeyboardState

キーボードの状態を得る

ヘッダ

SDL3/SDL_keyboard.h

構文

const bool * SDL_GetKeyboardState(int *numkeys);

引数

int *numkeysキー状態の配列の長さの代入先へのポインタ. NULLも可

戻り値

(const bool *) キー状態の配列へのポインタを戻す.

詳細

戻されたポインタはSDL内部の配列へのポインタである. アプリケーションの実行中は常に有効で, 呼び出し側は解放してはならない.

値が真のときキーが押されていて, 偽のときキーが押されていない. この配列のインデックス番号はSDL_Scancodeの値である.

SDL_PumpEvents()でこの状態は更新される.

この関数は全てのイベントを処理した後に状態を獲得する. そのため, もしイベントを処理する前にキーやボタンを押したり離したりすると, SDL_GetKeyboardState()では押されたキーを知ることができない.

注意: この関数はシフトキーの状態を考慮しない.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_GetKeyboardState - SDL Wiki