GameInputTouchSurfaceInfo

Describes the properties of a touch surface on an input device.

Syntax

struct GameInputTouchSurfaceInfo
{
    uint32_t maxContactCount;
    uint32_t padWidth;
    uint32_t padHeight;
    GameInputTouchSurfaceType type;
};

Members

maxContactCount
Type: uint32_t

Maximum number of simultaneous contacts that the surface can report. Use this value to size the array passed to IGameInputReading::GetTouchSurfaceState.

padWidth
Type: uint32_t

Width of the surface in device units. The padX member of GameInputTouchContact is in the range 0 to padWidth - 1.

padHeight
Type: uint32_t

Height of the surface in device units. The padY member of GameInputTouchContact is in the range 0 to padHeight - 1.

type
Type: GameInputTouchSurfaceType

Type of the touch surface, such as a touchscreen or a touchpad.

Remarks

This structure is filled by IGameInputDevice::GetTouchSurfaceInfo. Call IGameInputDevice::GetTouchSurfaceCount to get the number of touch surfaces on a device. A surface index used with GetTouchSurfaceInfo identifies the same surface in IGameInputReading::GetTouchContactCount and IGameInputReading::GetTouchSurfaceState.

If a device doesn't report the resolution of a surface, padWidth and padHeight can be set to a large normalized range rather than physical units. Treat the pad dimensions as a coordinate space, not as a physical size.

Requirements

Header: GameInput.h

Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

See also

Overview of GameInput
GameInput
GameInputTouchContact
GameInputTouchSurfaceType
IGameInputDevice::GetTouchSurfaceInfo

Version History

Version	Changes
v4	Introduced.