XR UI Input Module

The XR UI Input Module is the component that the XR Interaction Toolkit requires to properly interface with the Event System.

An XR UI Input Module works in concert with the Near-Far Interactor, XR Ray Interactor, and XR Poke Interactor to ensure the XR Interaction Toolkit interactions with the UI are processed correctly. It also handles input from other non-XR sources (such as gamepad or mouse) if configured to do so. In the component configuration pictured below, the Input System UI Actions and Input Manager options are displayed. Depending on the Active Input Handling setting in Edit > Project Settings > Player, one or both of these configuration options may be visible. If you are using the Input System package for handling input you have a few options for setup. We recommend using the XRI Default Input Actions.inputactions and XRI Default XR UI Input Module.preset file provided with the Starter Assets sample, which allows for the greatest control and flexibility. Alternatively, you can create an Input Action asset with associated Action Map and Actions and manually assign the Input System UI Actions for each of the fields. Finally, you can leave all the Input System UI Actions unset (None) and turn on the Enable Builtin Actions As Fallback checkbox, which will let the default mouse, gamepad, or joystick actions drive the UI with the current Input System devices configured.

Note

If you have Active Input Handling set to Both, you will need to make sure to set the Active Input Mode on the XR UI Input Module to your desired source of input. Keep in mind that there may be minor performance impacts by setting this option to Both.

Important

If you have an existing Canvas or Event System, you will likely have a Standalone Input Module or Input System UI Input Module component which will prevent proper input processing. Remove it by clicking the More menu (⋮) and selecting Remove Component. Other UI Input Modules are not compatible with the XR UI Input Module and may cause undesired or unexpected behavior. Therefore, only use a single Input Module to handle UI interactions.

UI Toolkit support

Warning

The XRUIInputModule does not yet fully support UI Toolkit.

When using UI Toolkit, typically it will install an event listener in the form of the PanelEventHandler component which intercepts events from the XRUIInputModule. However, the XRUIInputModule currently does not support sending UI Toolkit events from the Event System on behalf of the XRUIInputModule. Instead, EventSystem.SetUITookitEventSystemOverride can be called to bypass this default mechanism when it becomes the current/activated Input Module by the EventSystem. This is set up in a convenient option in the UI called Bypass UI Toolkit Events.