IInputConsumerEx

Description

interface Tinman.Engine.Application.IInputConsumerEx

Base interface for classes that consume input events (see InputEvent) and/or poll input state (see IInputState).

An IInputConsumerEx object can request to capture the mouse (see ShouldCaptureMouse). The outer code can then honor this request (for example via IApplicationWindow.MouseCaptured).

Public / Methods

InputAttach


public method InputAttach → (1)

input in : IInputState

[not-null]
The input state object.

Attaches this input consumer to the given input state object.

The input state object provides a snapshot of the input keys and buttons. It should not be used to detect up/down/click events.

InputDetach


public method InputDetach → ()

Detached this input consumer from its input state object.

Public / Attributes

ShouldCaptureMouse


public attribute ShouldCaptureMouse → (get)

value : bool

true if the mouse should be captured, false if not.

Should the mouse be captured, because this input consumer only processes relative input?