Skip to main content
Gets information about a touch surface on the input device.

Syntax

Parameters

surfaceIndex
Type: uint32_t
The zero-based index of the touch surface. This must be less than the value returned by IGameInputDevice::GetTouchSurfaceCount. info   _Out_
Type: GameInputTouchSurfaceInfo*
Receives information about the touch surface.

Return value

Type: HRESULT Returns S_OK on success. Returns E_BOUNDS if surfaceIndex is greater than or equal to the number of touch surfaces on the device; in that case, info is zeroed.

Remarks

The returned information describes the maximum number of simultaneous contacts that the surface can report, the dimensions of the surface in device units, and the type of the surface, such as a touchpad or a touchscreen. Contact positions reported by IGameInputReading::GetTouchSurfaceState are relative to these dimensions, so you can use them to normalize contact positions. The information doesn’t change for the lifetime of the device object. The following example normalizes the position of the first contact on each touch surface of a device to the range [0, 1).
Touch support depends on the device and the platform.

Requirements

Header: GameInput.h Library: gameinput.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

See also

Overview of GameInput
IGameInputDevice
GameInputTouchSurfaceInfo
IGameInputDevice::GetTouchSurfaceCount
IGameInputReading::GetTouchSurfaceState

Version History

Last modified on November 5, 2026