MGL マウス入力取得クラス [詳解]

#include <mgl_mouse.h>

公開メンバ関数
	Mouse () noexcept
	コンストラクタ

constexpr MouseServer &	GetServer () noexcept
	マウスサーバを取得

bool	IsAvailable () const noexcept
	マウスサーバが有効かどうかを返す

bool	IsPressing (MouseButton button) const noexcept
	ボタンが押されているかを取得

bool	IsPressing (MouseButtonFlags buttonFlags) const noexcept
	指定したボタンが全て押されているかを取得

bool	IsPressingAny (MouseButtonFlags buttonFlags=kMouseButtonAll) const noexcept
	指定したボタンのいずれかが押されているかを取得

bool	IsTriggered (MouseButton button) const noexcept
	ボタンが押された瞬間を取得

bool	IsReleased (MouseButton button) const noexcept
	ボタンが離された瞬間を取得

const Vector2 &	GetPosition () const noexcept
	マウスポインタの位置を取得

const Vector2 &	GetUVPosition () const noexcept
	マウスポインタの位置をUV座標で取得

const Vector2 &	GetDeltaMove () const noexcept
	マウスポインタの移動量を取得

const Vector2 &	GetUVDeltaMove () const noexcept
	マウスポインタの移動量をUV座標で取得

void	SetBounds (const Rectangle &bounds) noexcept
	マウスの入力範囲を設定

void	SetBounds (const Rectangle &bounds, const Vector2 &logicalSize) noexcept
	マウスの入力範囲を疑似サイズで設定

bool	SetCursorMode (CursorMode cursorMode) noexcept
	カーソルモードを設定

CursorMode	GetCursorMode () const noexcept
	カーソルモードを取得

void	SetCursorVisibleMode (CursorVisibleMode visibleMode) noexcept
	カーソルの表示モードを設定

CursorVisibleMode	GetCursorVisibleMode () const noexcept
	カーソルの表示モードを取得

MGL_MAYBE_CONSTEXPR bool	IsConnecting () const noexcept
	マウスの接続状態を取得

詳解

MGL マウス入力取得クラス

関数詳解

◆ GetCursorMode()

CursorMode MGL::Input::Mouse::GetCursorMode ( ) const

inlinenodiscardnoexcept

カーソルモードを取得

戻り値: 現在のカーソルモード

◆ GetCursorVisibleMode()

CursorVisibleMode MGL::Input::Mouse::GetCursorVisibleMode ( ) const

inlinenodiscardnoexcept

カーソルの表示モードを取得

戻り値: 現在のカーソルの表示モード

◆ GetDeltaMove()

const Vector2 & MGL::Input::Mouse::GetDeltaMove ( ) const

inlinenodiscardnoexcept

マウスポインタの移動量を取得

戻り値: マウスポインタの移動量

◆ GetPosition()

const Vector2 & MGL::Input::Mouse::GetPosition ( ) const

inlinenodiscardnoexcept

マウスポインタの位置を取得

戻り値: マウスポインタの位置

◆ GetServer()

MouseServer & MGL::Input::Mouse::GetServer ( )

inlineconstexprnoexcept

マウスサーバを取得

戻り値: マウスサーバ

◆ GetUVDeltaMove()

const Vector2 & MGL::Input::Mouse::GetUVDeltaMove ( ) const

inlinenodiscardnoexcept

マウスポインタの移動量をUV座標で取得

戻り値: マウスポインタの移動量

◆ GetUVPosition()

const Vector2 & MGL::Input::Mouse::GetUVPosition ( ) const

inlinenodiscardnoexcept

マウスポインタの位置をUV座標で取得

戻り値: マウスポインタの位置

◆ IsAvailable()

bool MGL::Input::Mouse::IsAvailable ( ) const

inlinenodiscardnoexcept

マウスサーバが有効かどうかを返す

戻り値

true	有効
false	無効

◆ IsConnecting()

MGL_MAYBE_CONSTEXPR bool MGL::Input::Mouse::IsConnecting ( ) const

inlinenodiscardnoexcept

マウスの接続状態を取得

戻り値

true	接続されている
false	接続されていない

◆ IsPressing() [1/2]

bool MGL::Input::Mouse::IsPressing ( MouseButton button ) const

inlinenodiscardnoexcept

ボタンが押されているかを取得

引数

[in] button チェックするボタン

戻り値

true	押されている
false	押されていない

◆ IsPressing() [2/2]

bool MGL::Input::Mouse::IsPressing ( MouseButtonFlags buttonFlags ) const

inlinenodiscardnoexcept

指定したボタンが全て押されているかを取得

引数

[in] buttonFlags チェックするボタンフラグ

戻り値

true	押されている
false	押されていない

◆ IsPressingAny()

bool MGL::Input::Mouse::IsPressingAny ( MouseButtonFlags buttonFlags = kMouseButtonAll ) const

inlinenodiscardnoexcept

指定したボタンのいずれかが押されているかを取得

引数

[in] buttonFlags チェックするボタンフラグ

戻り値

true	押されている
false	押されていない

◆ IsReleased()

bool MGL::Input::Mouse::IsReleased ( MouseButton button ) const

inlinenodiscardnoexcept

ボタンが離された瞬間を取得

引数

[in] button チェックするボタン

戻り値

true	離された瞬間である
false	離された瞬間ではない

◆ IsTriggered()

bool MGL::Input::Mouse::IsTriggered ( MouseButton button ) const

inlinenodiscardnoexcept

ボタンが押された瞬間を取得

引数

[in] button チェックするボタン

戻り値

true	押された瞬間である
false	押された瞬間ではない

◆ SetBounds() [1/2]

void MGL::Input::Mouse::SetBounds ( const Rectangle & bounds )

inlinenoexcept

マウスの入力範囲を設定

引数

[in] bounds 入力範囲

◆ SetBounds() [2/2]

void MGL::Input::Mouse::SetBounds	(	const Rectangle &	bounds,
		const Vector2 &	logicalSize )

inlinenoexcept

マウスの入力範囲を疑似サイズで設定

引数

[in]	bounds	入力範囲
[in]	logicalSize	論理サイズ

◆ SetCursorMode()

bool MGL::Input::Mouse::SetCursorMode ( CursorMode cursorMode )

inlinenoexcept

カーソルモードを設定

引数

[in] cursorMode 設定するカーソルモード

戻り値

true	成功
false	失敗

◆ SetCursorVisibleMode()

void MGL::Input::Mouse::SetCursorVisibleMode ( CursorVisibleMode visibleMode )

inlinenoexcept

カーソルの表示モードを設定

引数

[in] visibleMode 設定する表示モード

このクラス詳解は次のファイルから抽出されました:

/Users/acerola/x/mgl/include/mgl/input/mouse/mgl_mouse.h

公開メンバ関数

詳解

関数詳解

◆ GetCursorMode()

◆ GetCursorVisibleMode()

◆ GetDeltaMove()

◆ GetPosition()

◆ GetServer()

◆ GetUVDeltaMove()

◆ GetUVPosition()

◆ IsAvailable()

◆ IsConnecting()

◆ IsPressing() [1/2]

◆ IsPressing() [2/2]

◆ IsPressingAny()

◆ IsReleased()

◆ IsTriggered()

◆ SetBounds() [1/2]

◆ SetBounds() [2/2]

◆ SetCursorMode()

◆ SetCursorVisibleMode()