C4 Engine
C4 Engine API Documentation

InterfaceMgr::SetInputManagementMode

Defined in:  C4Interface.h
Sets the input management mode.
Prototype

SetInputManagementMode(InputManagementMode mode);

Parameters
mode The new input management mode.
Description
The SetInputManagementMode function determines whether the Interface Manager modifies the current Input Manager mode when windows are created and destroyed. The mode parameter can be one of the following constants.
kInputManagementManual The Interface Manager does not change the Input Manager mode when windows are created and destroyed.
kInputManagementAutomatic The Interface Manager automatically changes the Input Manager mode when windows are created and destroyed.
If the mode is kInputManagementAutomatic, then the Interface Manager sets the Input Manager mode to kInputAllActive whenever there are no windows visible that are capable of receiving user input. When there is at least one input-receiving window visible, the Interface Manager automatically sets the Input Manager mode to kInputInactive, meaning that mouse and keyboard events are sent to the currently active window and are not processed by the Input Manager.

If the mode is kInputManagementManual, then the Interface Manager does not modify the Input Manager mode regardless of whether input-receiving windows are visible.

A window is considered able to receive input if it does not have the kWindowPassive window flag set (see the Window class).

The default input management mode when the engine starts up is kInputManagementManual.
See Also

InputMgr::SetInputMode

Window