Struct GorgonRawMouseData

A representation of the Raw Input data received from WM_INPUT.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Gorgon.Input

Assembly: Gorgon.Input.dll

Syntax

public readonly struct GorgonRawMouseData

Remarks

This is a Gorgon friendly representation of the data received from the WM_INPUT window message. The data from Raw Input is parsed and placed in an instance of this type and sent to the appropriate GorgonRawMouse object to be turned into state for that device.

This type is not intended for use by applications.

Constructors

GorgonRawMouseData(Point, short, MouseButtonState, bool)

Initializes a new instance of the GorgonRawMouseData struct.

Declaration

public GorgonRawMouseData(Point position, short mouseWheel, MouseButtonState mouseButton, bool relative)

Parameters

Type	Name	Description
Point	position	The position of the mouse.
short	mouseWheel	The mouse wheel delta value.
MouseButtonState	mouseButton	The mouse buttons that are held down.
bool	relative	true if the positioning is relative, false if absolute.

Fields

ButtonState

The state of the mouse button

Declaration

public readonly MouseButtonState ButtonState

Field Value

Type	Description
MouseButtonState

IsRelative

Flag to indicate whether the Position value is relative or not.

Declaration

public readonly bool IsRelative

Field Value

Type	Description
bool

MouseWheelDelta

The change in the mouse wheel since the last event.

Declaration

public readonly short MouseWheelDelta

Field Value

Type	Description
short

Position

The current position of the mouse.

Declaration

public readonly Point Position

Field Value

Type	Description
Point

Remarks

If the IsRelative value is set to true, then this value will be a relative value based on the last known position of the mouse. Otherwise, this will return the absolute position of the mouse.