MouseFilter

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

Field	Value
Full name	Electron2D.MouseFilter
Namespace	Electron2D
Kind	enum
Category	UI and Text

Overview

Identifies how a Electron2D.Control receives and consumes mouse input.

Syntax

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

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Supported / Parity verified
Out of profile: no
Godot reference: Control.MouseFilter

Mouse filter values for stop, pass and ignore GUI input routing.

Remarks

The value is read by the root Electron2D.Viewport while it routes Electron2D.InputEventMouse events to controls.

A control can receive Electron2D.Control._GuiInput(Electron2D.InputEvent), pass the event to its parent control, stop further GUI input, or be ignored for mouse hit-testing.

Thread Safety

Enumeration values are immutable and may be read from any thread.

Since

This enum is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.MouseFilter
• Electron2D.Control._GuiInput(Electron2D.InputEvent)

Members

Member	Kind	Summary
Ignore	Enum value	The control is skipped by mouse GUI input hit-testing.
Pass	Enum value	The control receives mouse GUI input and lets unhandled events bubble.
Stop	Enum value	The control receives mouse GUI input and stops propagation afterward.

Member Details

Ignore

Kind: Enum value

public const Electron2D.MouseFilter Ignore

Summary

The control is skipped by mouse GUI input hit-testing.

Remarks

Descendant controls can still receive input when their own hit-test and filter settings allow it.

Thread Safety

Enumeration values are immutable and may be read from any thread.

Since

This field is available since Electron2D 0.1.0 Preview.

Pass

Kind: Enum value

public const Electron2D.MouseFilter Pass

Summary

The control receives mouse GUI input and lets unhandled events bubble.

Remarks

If the callback does not accept the event, the viewport continues the GUI input path with the parent Electron2D.Control when one exists.

Thread Safety

Enumeration values are immutable and may be read from any thread.

Since

This field is available since Electron2D 0.1.0 Preview.

Stop

Kind: Enum value

public const Electron2D.MouseFilter Stop

Summary

The control receives mouse GUI input and stops propagation afterward.

Remarks

If Electron2D.Control._GuiInput(Electron2D.InputEvent) does not call Electron2D.Control.AcceptEvent, the viewport marks the event handled after the callback returns.

Thread Safety

Enumeration values are immutable and may be read from any thread.

Since

This field is available since Electron2D 0.1.0 Preview.