Show / Hide Table of Contents

Interface IMouseState

Reports the state of the mouse.

Namespace: SadConsole.Input
Assembly: SadConsole.dll
Syntax
public interface IMouseState

Properties

IsLeftButtonDown

true when the left mouse button is pressed; otherwise, false.

Declaration
bool IsLeftButtonDown { get; }
Property Value
Type Description
bool

IsMiddleButtonDown

true when the middle mouse button is pressed; otherwise, false.

Declaration
bool IsMiddleButtonDown { get; }
Property Value
Type Description
bool

IsRightButtonDown

true when the right mouse button is pressed; otherwise, false.

Declaration
bool IsRightButtonDown { get; }
Property Value
Type Description
bool

MouseWheel

The value of the mouse wheel.

Declaration
int MouseWheel { get; }
Property Value
Type Description
int

ScreenPosition

The pixel position of the mouse on the screen relative to the game window.

Declaration
Point ScreenPosition { get; }
Property Value
Type Description
Point

Methods

Refresh()

If applicable to the host implementation, refreshes the mouse state.

Declaration
void Refresh()

Extension Methods

ExtensionsSystem.GetDebuggerDisplayValue(object)
In this article

Back to top

Back to top Generated by DocFX