MouseButtonMask

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

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

Overview

Provides bit flags for mouse buttons held during a mouse event.

Syntax

public enum Electron2D.MouseButtonMask : 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: MouseButtonMask

Held mouse button bit flags converted from platform state.

Remarks

The flag values match Electron2D mouse button masks. Platform button flags are converted to this representation by the internal input mapper.

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	The primary mouse button is held.
Middle	Enum value	The middle mouse button is held.
None	Enum value	No mouse buttons are held.
Right	Enum value	The secondary mouse button is held.
Xbutton1	Enum value	Extra mouse button 1 is held.
Xbutton2	Enum value	Extra mouse button 2 is held.

Member Details

Left

Kind: Enum value

public const Electron2D.MouseButtonMask Left

Summary

The primary mouse button is held.

Remarks

Use this value with APIs that accept MouseButtonMask.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButtonMask

Middle

Kind: Enum value

public const Electron2D.MouseButtonMask Middle

Summary

The middle mouse button is held.

Remarks

Use this value with APIs that accept MouseButtonMask.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButtonMask

None

Kind: Enum value

public const Electron2D.MouseButtonMask None

Summary

No mouse buttons are held.

Remarks

Use this value with APIs that accept MouseButtonMask.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButtonMask

Right

Kind: Enum value

public const Electron2D.MouseButtonMask Right

Summary

The secondary mouse button is held.

Remarks

Use this value with APIs that accept MouseButtonMask.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButtonMask

Xbutton1

Kind: Enum value

public const Electron2D.MouseButtonMask Xbutton1

Summary

Extra mouse button 1 is held.

Remarks

Use this value with APIs that accept MouseButtonMask.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButtonMask

Xbutton2

Kind: Enum value

public const Electron2D.MouseButtonMask Xbutton2

Summary

Extra mouse button 2 is held.

Remarks

Use this value with APIs that accept MouseButtonMask.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.MouseButtonMask