IGameInputDevice::GetMouseInfo

Retrieves the mouse properties of the device, such as its supported buttons, sample rate, and scroll wheels.

Syntax

bool GetMouseInfo(
    GameInputMouseInfo* info
);

Parameters

info _Out_
Type: GameInputMouseInfo* Pointer to a GameInputMouseInfo structure that receives the mouse properties of the device. If the device doesn’t support mouse input, every member of the structure is set to zero.

Return value

Type: bool true if the device supports mouse input and info was filled in; otherwise, false.

Remarks

The GetMouseInfo method copies the mouse properties of the device into the caller-provided structure. A device supports mouse input when the value returned by GetSupportedInput includes GameInputKindMouse. If the device doesn’t support mouse input, GetMouseInfo zero-initializes info and returns false. The supportedButtons member reports which GameInputMouseButtons the mouse has, and the hasWheelX and hasWheelY members report whether the mouse has horizontal and vertical scroll wheels. Mouse state is read from readings by using IGameInputReading::GetMouseState. The properties returned by this method are fixed for the lifetime of the device, so you can query them once (for example, when the device connects) and cache the result. The following example shows how to query the mouse properties of a device.

GameInputMouseInfo info;
if (device->GetMouseInfo(&info))
{
    if (info.hasWheelY)
    {
        // Enable scroll-wheel controls.
    }
}

In GameInput v3 and earlier, this information was available from the mouseInfo member of the GameInputDeviceInfo structure returned by IGameInputDevice::GetDeviceInfo.

Requirements

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

Version History

Version	Changes
v4	Introduced.

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

​Version History

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History