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

SDL_SetWindowRelativeMouseMode

ウィンドウの相対マウスモードを設定する

ヘッダ

SDL3/SDL_mouse.h

構文

bool SDL_SetWindowRelativeMouseMode(SDL_Window *window, bool enabled);

引数

SDL_Window *windowチェックするウィンドウ
boolenabled真のとき相対マウスモードを有効にする. 偽のとき無効にする

戻り値

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

詳細

マウスが相対モードでウィンドウがフォーカスされている間は, マウスカーソルが非表示になり, マウスの位置はウィンドウ内に制限され, SDLはマウスがウィンドウの端であってもマウスの相対的な動きを連続して報告する.

相対モードの間はマウスの位置を制限したい場合は, SDL_SetWindowMouseRect()を使うことができる. 相対モードを終えたときマウスを特定の位置に移動させたい場合は, 相対モードを無効にする前にSDL_WarpMouseInWindow()を使用すること.

この関数は未処理のマウス移動イベントを全て掃き出す.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_SetWindowRelativeMouseMode - SDL Wiki