Mouse Messages

Mouse input event messages. More...

Collaboration diagram for Mouse Messages:

Variables
const char *const	kMsgDMouseDown
	Mouse button press event.
const char *const	kMsgDMouseUp
	Mouse button release event.
const char *const	kMsgDMouseMove
	Absolute mouse movement.
const char *const	kMsgDMouseRelMove
	Relative mouse movement.
const char *const	kMsgDMouseWheel
	Mouse wheel scroll event.
const char *const	kMsgDMouseWheel1_0
	Mouse wheel scroll event (legacy v1.0-1.2)

Detailed Description

Mouse input event messages.

Variable Documentation

kMsgDMouseDown

const char* const kMsgDMouseDown

extern

Mouse button press event.

Message Code: "DMDN" Direction: Primary → Secondary Format: "DMDN%1i" Parameters:

• $1: ButtonID (1 byte) - Mouse button identifier

Examples:

Left mouse button pressed

"DMDN\x01"

Right mouse button pressed

"DMDN\x02"

Middle mouse button pressed

"DMDN\x03"

Button IDs:

• 1: Left button
• 2: Right button
• 3: Middle button
• 4+: Additional buttons (side buttons, etc.)

See also

kMsgDMouseUp

Since

Protocol version 1.0

kMsgDMouseMove

const char* const kMsgDMouseMove

extern

Absolute mouse movement.

Message Code: "DMMV" Direction: Primary → Secondary Format: "DMMV%2i%2i" Parameters:

• $1: X coordinate (2 bytes, signed) - Absolute screen position
• $2: Y coordinate (2 bytes, signed) - Absolute screen position

Example:

Move to (400, 300)

"DMMV\x01\x90\x01\x2C"

Coordinates are absolute positions on the secondary screen. The origin (0,0) is typically the top-left corner.

See also

kMsgDMouseRelMove

Since

Protocol version 1.0

kMsgDMouseRelMove

const char* const kMsgDMouseRelMove

extern

Relative mouse movement.

Message Code: "DMRM" Direction: Primary → Secondary Format: "DMRM%2i%2i" Parameters:

• $1: X delta (2 bytes, signed) - Horizontal movement
• $2: Y delta (2 bytes, signed) - Vertical movement

Example:

Move right 10, up 10 pixels

"DMRM\x00\x0A\xFF\xF6"

Relative movement is useful for:

• High-precision input devices
• Gaming applications
• When absolute positioning is not desired

See also

kMsgDMouseMove

Since

Protocol version 1.2

kMsgDMouseUp

const char* const kMsgDMouseUp

extern

Mouse button release event.

Message Code: "DMUP" Direction: Primary → Secondary Format: "DMUP%1i" Parameters:

• $1: ButtonID (1 byte) - Mouse button identifier

Example:

Left mouse button released

"DMUP\x01"

Button IDs are the same as for kMsgDMouseDown.

See also

kMsgDMouseDown

Since

Protocol version 1.0

kMsgDMouseWheel

const char* const kMsgDMouseWheel

extern

Mouse wheel scroll event.

Message Code: "DMWM" Direction: Primary → Secondary Format: "DMWM%2i%2i" Parameters:

• $1: X delta (2 bytes, signed) - Horizontal scroll
• $2: Y delta (2 bytes, signed) - Vertical scroll

Example:

Scroll up one tick (+120)

"DMWM\x00\x00\x00\x78"

Scroll down one tick (-120)

"DMWM\x00\x00\xFF\x88"

Scroll right one tick (+120)

"DMWM\x00\x78\x00\x00"

Scroll Values:

• +120: One tick forward (away from user) or right
• -120: One tick backward (toward user) or left
• Values are typically multiples of 120

Directions:

• Vertical: Positive = up/away, Negative = down/toward
• Horizontal: Positive = right, Negative = left

See also

kMsgDMouseWheel1_0

Since

Protocol version 1.3

kMsgDMouseWheel1_0

const char* const kMsgDMouseWheel1_0

extern

Mouse wheel scroll event (legacy v1.0-1.2)

Message Code: "DMWM" Direction: Primary → Secondary Format: "DMWM%2i" Parameters:

• $1: Y delta (2 bytes, signed) - Vertical scroll only

Legacy version that only supports vertical scrolling. Used when communicating with protocol versions 1.0-1.2.

Deprecated

Use kMsgDMouseWheel for protocol version 1.3+

See also

kMsgDMouseWheel

Since

Protocol version 1.0