インターフェイス IInputKey

Namespace: GameCanvas

public interface IInputKey

プロパティ

IsScreenKeyboardSupported

bool IsScreenKeyboardSupported { get; }

スクリーンキーボードがサポートされているかどうか

IsScreenKeyboardVisible

bool IsScreenKeyboardVisible { get; }

スクリーンキーボードが表示されているかどうか

KeyDownCount

int KeyDownCount { get; }

前回のフレーム処理以降に 押されたキーの数

KeyHoldCount

int KeyHoldCount { get; }

前回のフレームに引き続き 押されているキーの数（押された瞬間を除く）

KeyUpCount

int KeyUpCount { get; }

前回のフレーム処理以降に 離されたキーの数

メソッド

HideScreenKeyboard()

void HideScreenKeyboard()

スクリーンキーボードを閉じます

IsKeyDown(Key)

bool IsKeyDown(in Key key)

指定されたキーが押されたかどうか

パラメーター

• key — キー

戻り値

押されたかどうか

IsKeyHold(Key)

bool IsKeyHold(in Key key)

指定されたキーが押されているかどうか（押された瞬間を除く）

パラメーター

• key — キー

戻り値

押されているかどうか（押された瞬間を除く）

IsKeyPress(Key)

bool IsKeyPress(in Key key)

指定されたキーが押されているかどうか（押された瞬間を含む）

パラメーター

• key — キー

戻り値

押されているかどうか（押された瞬間を含む）

IsKeyUp(Key)

bool IsKeyUp(in Key key)

指定されたキーが離されたかどうか

パラメーター

• key — キー

戻り値

離されたかどうか

ShowScreenKeyboard()

bool ShowScreenKeyboard()

スクリーンキーボードを表示します

戻り値

表示できたかどうか

TryGetKeyEvent(Key, GcKeyEvent)

bool TryGetKeyEvent(in Key key, out GcKeyEvent e)

指定されたキーのキーイベントがあれば取得します

パラメーター

• key — キー
• e — キーイベント

戻り値

取得できたかどうか

TryGetKeyEventAll(GcKeyEventPhase, System.ReadOnlySpan<GcKeyEvent>)

bool TryGetKeyEventAll(in GcKeyEventPhase phase, out System.ReadOnlySpan<GcKeyEvent> events)

前回のフレーム処理以降に更新された 指定された状態のキーイベント全てを取得します

パラメーター

• phase — キーイベント状態
• events — キーイベントの一覧

戻り値

要素数が1以上かどうか

TryGetKeyEventAll(System.ReadOnlySpan<GcKeyEvent>)

bool TryGetKeyEventAll(out System.ReadOnlySpan<GcKeyEvent> events)

前回のフレーム処理以降に更新された キーイベント全てを取得します

パラメーター

• events — キーイベントの一覧

戻り値

要素数が1以上かどうか

TryGetKeyTrace(Key, GcKeyTrace)

bool TryGetKeyTrace(in Key key, out GcKeyTrace trace)

指定されたキーの軌跡があれば取得します

パラメーター

• key — キー
• trace — キーの軌跡

戻り値

取得できたかどうか

TryGetKeyTraceAll(GcKeyEventPhase, System.ReadOnlySpan<GcKeyTrace>)

bool TryGetKeyTraceAll(in GcKeyEventPhase phase, out System.ReadOnlySpan<GcKeyTrace> traces)

前回のフレーム処理以降に更新された キーの軌跡全てを取得します

パラメーター

• phase — キーイベント状態
• traces — キーの軌跡の一覧

戻り値

要素数が1以上かどうか

TryGetKeyTraceAll(System.ReadOnlySpan<GcKeyTrace>)

bool TryGetKeyTraceAll(out System.ReadOnlySpan<GcKeyTrace> traces)

前回のフレーム処理以降に更新された キーの軌跡全てを取得します

パラメーター

• traces — キーの軌跡の一覧

戻り値

要素数が1以上かどうか

TryGetScreenKeyboardArea(GcAABB)

bool TryGetScreenKeyboardArea(out GcAABB area)

スクリーンキーボードの表示位置を取得します

備考

• 表示中のみ取得できます
• 表示直後のアニメーション中は取得できません
• Android OSでは取得できません

パラメーター

• area — 表示位置（キャンバス座標系）

戻り値

取得できたかどうか