InputEventMouse

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

Field	Value
Full name	Electron2D.InputEventMouse
Namespace	Electron2D
Kind	class
Category	Input

Overview

Base class for mouse input events.

Syntax

public class Electron2D.InputEventMouse : Electron2D.InputEventWithModifiers

Remarks

Mouse events carry viewport-local and global positions. In the 0.1.0 Preview baseline these positions are identical because viewport scaling and GUI local coordinates are not yet part of the input pipeline.

Instances are mutable and are not synchronized; use them from the input dispatch thread that owns the event.

Thread Safety

Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.

Since

This class is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
ButtonMask	Property	Gets or sets the button mask active when the mouse event was generated.
GlobalPosition	Property	Gets or sets the event position in the root viewport.
Position	Property	Gets or sets the event position in the current viewport.
Electron2D.InputEventMouse()	Constructor	Initializes a new instance of the Electron2D.InputEventMouse class.

Member Details

ButtonMask

Kind: Property

public Electron2D.MouseButtonMask ButtonMask { get; set; }

Summary

Gets or sets the button mask active when the mouse event was generated.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current button mask value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouse

GlobalPosition

Kind: Property

public Electron2D.Vector2 GlobalPosition { get; set; }

Summary

Gets or sets the event position in the root viewport.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current global position value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouse

Position

Kind: Property

public Electron2D.Vector2 Position { get; set; }

Summary

Gets or sets the event position in the current viewport.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current position value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouse

Electron2D.InputEventMouse()

Kind: Constructor

public Electron2D.InputEventMouse()

Summary

Initializes a new instance of the Electron2D.InputEventMouse class.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouse