Struct MouseState

Combine a single pointer with buttons and a scroll wheel.

Namespace: UnityEngine.InputSystem.LowLevel

Syntax

public struct MouseState : IInputStateTypeInfo

Fields

buttons

Declaration

public ushort buttons

Field Value

Type	Description
System.UInt16

clickCount

Declaration

public ushort clickCount

Field Value

Type	Description
System.UInt16

delta

Declaration

public Vector2 delta

Field Value

Type	Description
Vector2

position

Declaration

public Vector2 position

Field Value

Type	Description
Vector2

scroll

Declaration

public Vector2 scroll

Field Value

Type	Description
Vector2

Properties

format

Declaration

public FourCC format { get; }

Property Value

Type	Description
FourCC

Implements

IInputStateTypeInfo.format

kFormat

Declaration

public static FourCC kFormat { get; }

Property Value

Type	Description
FourCC

Methods

WithButton(MouseButton, Boolean)

Declaration

public MouseState WithButton(MouseButton button, bool state = true)

Parameters

Type	Name	Description
MouseButton	button
System.Boolean	state

Returns

Type	Description
MouseState