Interface IInputKey
Namespace: GameCanvas
Assembly: GameCanvas.dll
Syntax
public interface IInputKey
Properties
IsScreenKeyboardSupported
スクリーンキーボードがサポートされているかどうか
Declaration
bool IsScreenKeyboardSupported { get; }
Property Value
Type | Description |
---|---|
Boolean |
IsScreenKeyboardVisible
スクリーンキーボードが表示されているかどうか
Declaration
bool IsScreenKeyboardVisible { get; }
Property Value
Type | Description |
---|---|
Boolean |
KeyDownCount
前回のフレーム処理以降に 押されたキーの数
Declaration
int KeyDownCount { get; }
Property Value
Type | Description |
---|---|
Int32 |
KeyHoldCount
前回のフレームに引き続き 押されているキーの数(押された瞬間を除く)
Declaration
int KeyHoldCount { get; }
Property Value
Type | Description |
---|---|
Int32 |
KeyUpCount
前回のフレーム処理以降に 離されたキーの数
Declaration
int KeyUpCount { get; }
Property Value
Type | Description |
---|---|
Int32 |
Methods
HideScreenKeyboard()
スクリーンキーボードを閉じます
Declaration
void HideScreenKeyboard()
IsKeyDown(Key)
指定されたキーが押されたかどうか
Declaration
bool IsKeyDown(in Key key)
Parameters
Type | Name | Description |
---|---|---|
Key | key | キー |
Returns
Type | Description |
---|---|
Boolean | 押されたかどうか |
IsKeyHold(Key)
指定されたキーが押されているかどうか(押された瞬間を除く)
Declaration
bool IsKeyHold(in Key key)
Parameters
Type | Name | Description |
---|---|---|
Key | key | キー |
Returns
Type | Description |
---|---|
Boolean | 押されているかどうか(押された瞬間を除く) |
IsKeyPress(Key)
指定されたキーが押されているかどうか(押された瞬間を含む)
Declaration
bool IsKeyPress(in Key key)
Parameters
Type | Name | Description |
---|---|---|
Key | key | キー |
Returns
Type | Description |
---|---|
Boolean | 押されているかどうか(押された瞬間を含む) |
IsKeyUp(Key)
指定されたキーが離されたかどうか
Declaration
bool IsKeyUp(in Key key)
Parameters
Type | Name | Description |
---|---|---|
Key | key | キー |
Returns
Type | Description |
---|---|
Boolean | 離されたかどうか |
ShowScreenKeyboard()
スクリーンキーボードを表示します
Declaration
bool ShowScreenKeyboard()
Returns
Type | Description |
---|---|
Boolean | 表示できたかどうか |
TryGetKeyEvent(Key, out GcKeyEvent)
指定されたキーのキーイベントがあれば取得します
Declaration
bool TryGetKeyEvent(in Key key, out GcKeyEvent e)
Parameters
Type | Name | Description |
---|---|---|
Key | key | キー |
GcKeyEvent | e | キーイベント |
Returns
Type | Description |
---|---|
Boolean | 取得できたかどうか |
TryGetKeyEventAll(GcKeyEventPhase, out ReadOnlySpan<GcKeyEvent>)
前回のフレーム処理以降に更新された 指定された状態のキーイベント全てを取得します
Declaration
bool TryGetKeyEventAll(in GcKeyEventPhase phase, out ReadOnlySpan<GcKeyEvent> events)
Parameters
Type | Name | Description |
---|---|---|
GcKeyEventPhase | phase | キーイベント状態 |
ReadOnlySpan<GcKeyEvent> | events | キーイベントの一覧 |
Returns
Type | Description |
---|---|
Boolean | 要素数が1以上かどうか |
TryGetKeyEventAll(out ReadOnlySpan<GcKeyEvent>)
前回のフレーム処理以降に更新された キーイベント全てを取得します
Declaration
bool TryGetKeyEventAll(out ReadOnlySpan<GcKeyEvent> events)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlySpan<GcKeyEvent> | events | キーイベントの一覧 |
Returns
Type | Description |
---|---|
Boolean | 要素数が1以上かどうか |
TryGetKeyTrace(Key, out GcKeyTrace)
指定されたキーの軌跡があれば取得します
Declaration
bool TryGetKeyTrace(in Key key, out GcKeyTrace trace)
Parameters
Type | Name | Description |
---|---|---|
Key | key | キー |
GcKeyTrace | trace | キーの軌跡 |
Returns
Type | Description |
---|---|
Boolean | 取得できたかどうか |
TryGetKeyTraceAll(GcKeyEventPhase, out ReadOnlySpan<GcKeyTrace>)
前回のフレーム処理以降に更新された キーの軌跡全てを取得します
Declaration
bool TryGetKeyTraceAll(in GcKeyEventPhase phase, out ReadOnlySpan<GcKeyTrace> traces)
Parameters
Type | Name | Description |
---|---|---|
GcKeyEventPhase | phase | キーイベント状態 |
ReadOnlySpan<GcKeyTrace> | traces | キーの軌跡の一覧 |
Returns
Type | Description |
---|---|
Boolean | 要素数が1以上かどうか |
TryGetKeyTraceAll(out ReadOnlySpan<GcKeyTrace>)
前回のフレーム処理以降に更新された キーの軌跡全てを取得します
Declaration
bool TryGetKeyTraceAll(out ReadOnlySpan<GcKeyTrace> traces)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlySpan<GcKeyTrace> | traces | キーの軌跡の一覧 |
Returns
Type | Description |
---|---|
Boolean | 要素数が1以上かどうか |
TryGetScreenKeyboardArea(out GcAABB)
スクリーンキーボードの表示位置を取得します
Declaration
bool TryGetScreenKeyboardArea(out GcAABB area)
Parameters
Type | Name | Description |
---|---|---|
GcAABB | area | 表示位置(キャンバス座標系) |
Returns
Type | Description |
---|---|
Boolean | 取得できたかどうか |
Remarks
- 表示中のみ取得できます
- 表示直後のアニメーション中は取得できません
- Android OSでは取得できません