Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/UGameViewportClient
Description
Check a key event received by the viewport. If the viewport client uses the event, it should return true to consume it.
Virtual Inheritance
- FViewportClient::InputTouch → UGameViewportClient::InputTouch
| Name | InputTouch |
| Type | function |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/GameViewportClient.h |
| Include Path | #include "Engine/GameViewportClient.h" |
| Source | /Engine/Source/Runtime/Engine/Private/GameViewportClient.cpp |
virtual bool InputTouch
(
FViewport * Viewport,
const FInputDeviceId DeviceId,
uint32 Handle,
ETouchType::Type Type,
const FVector2D & TouchLocation,
float Force,
uint32 TouchpadIndex,
const uint64 Timestamp
)
True to consume the key event, false to pass it on.
Parameters
| Name | Remarks |
|---|---|
| Viewport | The viewport which the event is from. |
| DeviceId | The input device id from which this event is from |
| Handle | Identifier unique to this touch event |
| Type | What kind of touch event this is (see ETouchType) |
| TouchLocation | Screen position of the touch |
| Force | How hard the touch is |
| TouchpadIndex | For devices with multiple touchpads, this is the index of which one |
| Timestamp | The timestamp of when this input event was originally polled in the form of CPU cycles. |