MouseButton

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.MouseButton
Namespace	Electron2D
Kind	enum
Category	Input

Overview

Identifies a mouse button or mouse wheel direction in the Electron2D input model.

Syntax

public enum Electron2D.MouseButton : System.IComparable, System.IConvertible, System.IFormattable, System.ISpanFormattable

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: MouseButton

Left/right/middle, wheel and extra button constants for mouse events.

Remarks

Wheel steps are represented as button constants, matching Electron2D's InputEventMouseButton model.

This enum is immutable and is safe to use from any thread.

Since

This enum is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
Left	Enum value	Primary mouse button.
Middle	Enum value	Middle mouse button.
None	Enum value	No mouse button.
Right	Enum value	Secondary mouse button.
WheelDown	Enum value	Mouse wheel scrolling down.
WheelLeft	Enum value	Mouse wheel scrolling left.
WheelRight	Enum value	Mouse wheel scrolling right.
WheelUp	Enum value	Mouse wheel scrolling up.
Xbutton1	Enum value	Extra mouse button 1.
Xbutton2	Enum value	Extra mouse button 2.

Member Details

Left

Kind: Enum value

public const Electron2D.MouseButton Left

Summary

Primary mouse button.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton

Middle

Kind: Enum value

public const Electron2D.MouseButton Middle

Summary

Middle mouse button.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton

None

Kind: Enum value

public const Electron2D.MouseButton None

Summary

No mouse button.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton

Right

Kind: Enum value

public const Electron2D.MouseButton Right

Summary

Secondary mouse button.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton

WheelDown

Kind: Enum value

public const Electron2D.MouseButton WheelDown

Summary

Mouse wheel scrolling down.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton

WheelLeft

Kind: Enum value

public const Electron2D.MouseButton WheelLeft

Summary

Mouse wheel scrolling left.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton

WheelRight

Kind: Enum value

public const Electron2D.MouseButton WheelRight

Summary

Mouse wheel scrolling right.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton

WheelUp

Kind: Enum value

public const Electron2D.MouseButton WheelUp

Summary

Mouse wheel scrolling up.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton

Xbutton1

Kind: Enum value

public const Electron2D.MouseButton Xbutton1

Summary

Extra mouse button 1.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton

Xbutton2

Kind: Enum value

public const Electron2D.MouseButton Xbutton2

Summary

Extra mouse button 2.

Remarks

Use this value with APIs that accept MouseButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButton