Class Mouse

Namespace

BSGameLib.Game.Input

Assembly

BSGameLib.Game.dll

The mouse, from the OS's mouse state. Read it through Instance.

public class Mouse

Inheritance

object

Mouse

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Instance

The mouse. It is created the first time it is used.

public static Mouse Instance { get; }

Property Value

Mouse

IsRelativeMode

Whether the mouse is in relative mode, where the cursor is hidden and locked and movement is reported instead of position. Always false until a game window exists.

public bool IsRelativeMode { get; set; }

Property Value

bool

IsVisible

Whether the cursor is shown. The game sets it from MouseVisible when it starts, and it may be changed at any time. Dear ImGui changes the cursor's shape but does not show it while this is false.

public bool IsVisible { get; set; }

Property Value

bool

Methods

GetSnapshot()

Reads the mouse now. Returns an empty snapshot when the read fails.

public Mouse.Snapshot GetSnapshot()

Returns

Mouse.Snapshot