UGameViewportClient::InputTouch

Check a key event received by the viewport.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/GameViewportClient.h

Include

#include "Engine/GameViewportClient.h"

Source

/Engine/Source/Runtime/Engine/Private/GameViewportClient.cpp

Syntax

virtual bool InputTouch
(
    FViewport * Viewport,
    int32 ControllerId,
    uint32 Handle,
    ETouchType::Type Type,
    const FVector2D & TouchLocation,
    float Force,
    FDateTime DeviceTimestamp,
    uint32 TouchpadIndex
)

Remarks

Check a key event received by the viewport. If the viewport client uses the event, it should return true to consume it.

Returns

True to consume the key event, false to pass it on.

Parameters

Parameter

Description

Viewport

The viewport which the event is from.

ControllerId

The controller which the key 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

DeviceTimestamp

Timestamp of the event

TouchpadIndex

For devices with multiple touchpads, this is the index of which one