Interface IInputKey

Namespace

GameCanvas

Assembly

GameCanvas.dll

public interface IInputKey

Properties

IsScreenKeyboardSupported

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

bool IsScreenKeyboardSupported { get; }

Property Value

bool

IsScreenKeyboardVisible

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

bool IsScreenKeyboardVisible { get; }

Property Value

bool

KeyDownCount

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

int KeyDownCount { get; }

Property Value

int

KeyHoldCount

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

int KeyHoldCount { get; }

Property Value

int

KeyUpCount

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

int KeyUpCount { get; }

Property Value

int

Methods

HideScreenKeyboard()

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

void HideScreenKeyboard()

IsKeyDown(in Key)

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

bool IsKeyDown(in Key key)

Parameters

key Key

キー

Returns

bool

押されたかどうか

IsKeyHold(in Key)

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

bool IsKeyHold(in Key key)

Parameters

key Key

キー

Returns

bool

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

IsKeyPress(in Key)

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

bool IsKeyPress(in Key key)

Parameters

key Key

キー

Returns

bool

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

IsKeyUp(in Key)

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

bool IsKeyUp(in Key key)

Parameters

key Key

キー

Returns

bool

離されたかどうか

ShowScreenKeyboard()

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

bool ShowScreenKeyboard()

Returns

bool

表示できたかどうか

TryGetKeyEvent(in Key, out GcKeyEvent)

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

bool TryGetKeyEvent(in Key key, out GcKeyEvent e)

Parameters

key Key

キー

e GcKeyEvent

キーイベント

Returns

bool

取得できたかどうか

TryGetKeyEventAll(in GcKeyEventPhase, out ReadOnlySpan<GcKeyEvent>)

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

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

Parameters

phase GcKeyEventPhase

キーイベント状態

events ReadOnlySpan<GcKeyEvent>

キーイベントの一覧

Returns

bool

要素数が1以上かどうか

TryGetKeyEventAll(out ReadOnlySpan<GcKeyEvent>)

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

bool TryGetKeyEventAll(out ReadOnlySpan<GcKeyEvent> events)

Parameters

events ReadOnlySpan<GcKeyEvent>

キーイベントの一覧

Returns

bool

要素数が1以上かどうか

TryGetKeyTrace(in Key, out GcKeyTrace)

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

bool TryGetKeyTrace(in Key key, out GcKeyTrace trace)

Parameters

key Key

キー

trace GcKeyTrace

キーの軌跡

Returns

bool

取得できたかどうか

TryGetKeyTraceAll(in GcKeyEventPhase, out ReadOnlySpan<GcKeyTrace>)

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

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

Parameters

phase GcKeyEventPhase

キーイベント状態

traces ReadOnlySpan<GcKeyTrace>

キーの軌跡の一覧

Returns

bool

要素数が1以上かどうか

TryGetKeyTraceAll(out ReadOnlySpan<GcKeyTrace>)

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

bool TryGetKeyTraceAll(out ReadOnlySpan<GcKeyTrace> traces)

Parameters

traces ReadOnlySpan<GcKeyTrace>

キーの軌跡の一覧

Returns

bool

要素数が1以上かどうか

TryGetScreenKeyboardArea(out GcAABB)

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

bool TryGetScreenKeyboardArea(out GcAABB area)

Parameters

area GcAABB

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

Returns

bool

取得できたかどうか

Remarks

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