Enum InputSettings.BackgroundBehavior

Determines how the applications behaves when running in the background. See backgroundBehavior.

Namespace: UnityEngine.InputSystem
Assembly: Unity.InputSystem.dll
Syntax
public enum InputSettings.BackgroundBehavior

Fields

Name Description
IgnoreFocus

Ignore all changes in focus and leave devices untouched. This also disables focus checks in InputSystemUIInputModule.
ResetAndDisableAllDevices

Like ResetAndDisableNonBackgroundDevices but instead treat all devices as having canRunInBackground return false. This effectively means that all input is silenced while the application is running in the background.
ResetAndDisableNonBackgroundDevices

When the application loses focus, issue a ResetDevice(InputDevice, bool) call on every InputDevice that is not marked as canRunInBackground and then disable the device (see DisableDevice(InputDevice, bool) and enabled). Devices that canRunInBackground will not be touched and will keep running as is.

In effect, this setting will "soft-reset" all devices that cannot receive input while the application does not have focus. That is, it will reset all controls that are not marked as dontReset to their default state.

When the application comes back into focus, all devices that have been reset and disabled will be re-enabled and a synchronization request (see RequestSyncCommand) will be sent to each device.

Devices that are added while the application is running in the background are treated like devices that were already present when losing focus. That is, if they cannot run in the background, they will be disabled until focus comes back.

Note that the resets will cancel InputActions that are in progress from controls on devices that are being reset.
See Also