目次 - SDL 3.0 API(機能別) - マウス - SDL_GetMouseState

SDL_GetMouseState

SDLがキャッシュした同期したマウスボタンの状態とウィンドウ上のマウスカーソルの位置を得る

ヘッダ

SDL3/SDL_mouse.h

構文

SDL_MouseButtonFlags SDL_GetMouseState(float *x, float *y);

引数

float *xSDLのカーソルのフォーカスされたウィンドウの左上からのX座標の代入先のポインタ. NULLも可
float *ySDLのカーソルのフォーカスされたウィンドウの左上からのY座標の代入先のポインタ. NULLも可

戻り値

(SDL_MouseButtonFlags) SDL_BUTTON_MASK(X)マクロで比較可能な32ビットのビットマスクによるボタンの状態を戻す.

詳細

この関数は, イベントキューから最後に得たSDLが認識する同期的にキャッシュしたマウスの状態を戻す.

動作環境から非同期に状態を得たい場合は, SDL_GetGlobalMouseState()を使用すること.

NULLでないポインタをxyに渡すと, フォーカスされたウィンドウのXとY座標が書き込まれる.

相対モードでは, SDLのマウスの位置と, SDL_GetMouseState()SDL_GetWindowPosition()で得たSDLのマウスの位置は, 通常一致する.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_GetMouseState - SDL Wiki