Enum InputSettings.BackgroundBehavior
Determines how the applications behaves when running in the background. See backgroundBehavior.
Assembly: Unity.InputSystem.dll
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.
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.