GameInputMouseState

Describes the state of a mouse.

Syntax

typedef struct GameInputMouseState {  
    GameInputMouseButtons buttons;  
    int64_t positionX;  
    int64_t positionY;  
    int64_t wheelX;  
    int64_t wheelY;  
} GameInputMouseState  

Members

buttons
Type: GameInputMouseButtons

State of the mouse buttons.

positionX
Type: int64_t

Cumulative x-axis change in the position of the mouse.

positionY
Type: int64_t

Cumulative y-axis change in the position of the mouse.

wheelX
Type: int64_t

Cumulative change in the x-axis scroll wheel.

wheelY
Type: int64_t

Cumulative change in the y-axis scroll wheel.

Remarks

This structure is used by the IGameInputReading::GetMouseState method.

Mouse and scroll-wheel movements are not reported as absolute positions. Calculate deltas by subtracting the values in the current reading from the values in the previous reading.

For more information, see GameInput readings.

Requirements

Header: GameInput.h

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

See also

Overview of GameInput
GameInput