MGL::Input::KeyboardServer クラス

キーボードサーバ [詳解]

#include <mgl_keyboard_server.h>

MGL::Input::KeyboardServer の継承関係図

公開メンバ関数
	KeyboardServer () noexcept
	コンストラクタ
bool	Initialize (STL::unique_ptr< KeyboardDelegate > &delegate) noexcept
	初期化処理
bool	IsAvailable () const noexcept
	キーボードサーバが有効かどうかを返す
bool	IsPressing (Keycode keycode) const noexcept
	指定したキーが押されているかを取得
bool	IsTriggered (Keycode keycode) const noexcept
	指定したキーが押された瞬間を取得
bool	IsReleased (Keycode keycode) const noexcept
	指定したキーが離された瞬間を取得
bool	IsARepeat (Keycode keycode) const noexcept
	指定したキーのリピート入力状態を取得
constexpr void	SetRepeatSetting (const RepeatSetting &repeatSetting) noexcept
	リピート入力を設定
constexpr const RepeatSetting &	GetRepeatSetting () const noexcept
	リピート入力の設定状態を取得
constexpr bool	IsConnecting () const noexcept
	キーボードが接続されているかを取得
基底クラス MGL::SharedSingleton< KeyboardServer > に属する継承公開メンバ関数
	SharedSingleton (const SharedSingleton &) noexcept=delete
	SharedSingleton (SharedSingleton &&) noexcept=delete
SharedSingleton &	operator= (const SharedSingleton &) noexcept=delete
SharedSingleton &	operator= (SharedSingleton &&) noexcept=delete

静的公開メンバ関数
static STL::unique_ptr< KeyboardServer > &	GetInstanceRef () noexcept
	インスタンスの取得
基底クラス MGL::SharedSingleton< KeyboardServer > に属する継承静的公開メンバ関数
static KeyboardServer &	CreateInstance (Args... args) noexcept
	インスタンスの生成
static KeyboardServer &	GetInstance () noexcept
	インスタンスの取得
static void	DestroyInstance () noexcept
	インスタンスの破棄
static bool	HasInstance () noexcept
	有効なインスタンスを保持しているかを取得

詳解

キーボードサーバ

関数詳解

GetInstanceRef()

STL::unique_ptr< KeyboardServer > & MGL::Input::KeyboardServer::GetInstanceRef ( )

staticnoexcept

インスタンスの取得

戻り値

インスタンスの参照

GetRepeatSetting()

const RepeatSetting & MGL::Input::KeyboardServer::GetRepeatSetting ( ) const

inlinenodiscardconstexprnoexcept

リピート入力の設定状態を取得

戻り値

現在の設定状態

Initialize()

bool MGL::Input::KeyboardServer::Initialize ( STL::unique_ptr< KeyboardDelegate > & delegate )

noexcept

初期化処理

引数

[in]

delegate

キーボード入力デリゲート

戻り値

true	成功
false	失敗

IsARepeat()

bool MGL::Input::KeyboardServer::IsARepeat ( Keycode keycode ) const

nodiscardnoexcept

指定したキーのリピート入力状態を取得

引数

[in]

keycode

キーコード

戻り値

true	リピート入力あり
false	リピート入力なし

IsAvailable()

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

inlinenodiscardnoexcept

キーボードサーバが有効かどうかを返す

戻り値

true	有効
false	無効

IsConnecting()

bool MGL::Input::KeyboardServer::IsConnecting ( ) const

inlinenodiscardconstexprnoexcept

キーボードが接続されているかを取得

戻り値

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

IsPressing()

bool MGL::Input::KeyboardServer::IsPressing ( Keycode keycode ) const

nodiscardnoexcept

指定したキーが押されているかを取得

引数

[in]

keycode

キーコード

戻り値

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

IsReleased()

bool MGL::Input::KeyboardServer::IsReleased ( Keycode keycode ) const

nodiscardnoexcept

指定したキーが離された瞬間を取得

引数

[in]

keycode

キーコード

戻り値

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

IsTriggered()

bool MGL::Input::KeyboardServer::IsTriggered ( Keycode keycode ) const

nodiscardnoexcept

指定したキーが押された瞬間を取得

引数

[in]

keycode

キーコード

戻り値

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

SetRepeatSetting()

void MGL::Input::KeyboardServer::SetRepeatSetting ( const RepeatSetting & repeatSetting )

inlineconstexprnoexcept

リピート入力を設定

引数

[in]

repeatSetting

リピート入力設定

---

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

• /Users/acerola/work/mgl-work/mgl/include/mgl/input/keyboard/mgl_keyboard_server.h
• /Users/acerola/work/mgl-work/mgl/src/input/keyboard/mgl_keyboard_server.cc