Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


PanelInputConfiguration

Configures how input is routed to Panels in runtime. If no Input Configuration component is active, default configurations are used.
Read time 7 minutesLast updated a day ago

Definition

[AddComponentMenu("UI Toolkit/Panel Input Configuration", 1)][HelpURL("UIE-get-started-with-runtime-ui")]public sealed class PanelInputConfiguration : MonoBehaviour

Properties

Property

Description

autoCreatePanelComponentsWhen enabled, automatically creates child GameObjects with raycaster and event handler components attached to uGUI's EventSystem.
defaultEventCameraIsMainCameraThis option is enabled by default, automatically selecting the Main Camera (if available) as the Event Camera to transform screen positions into world-space rays.
eventCamerasThe list of Event Cameras used to transform screen positions into world-space rays.
interactionLayersThe Physics layers considered when casting world-space rays to determine the target of pointer events. Any UIDocument with one or more Collider on the Interaction Layers, or with GameObject children with colliders on the Interaction Layers, sends pointer events corresponding to the input rays to its panel. Other Colliders on those layers block panel events.
maxInteractionDistanceThe maximal distance considered when casting world-space rays to determine the target of pointer events.
panelInputRedirectionSelected option for whether or not panel input should be redirected from uGUI's EventSystem.
processWorldSpaceInputThis option is enabled by default, allowing panels that use the World Space rendering mode to receive events. When disabled, only Screen Space Overlay panels receive events.

Enums

Enum

Description

PanelInputConfiguration.PanelInputRedirectionIndicates whether the uGUI EventSystem redirects panel input.

Inheritance

Inherited Members

Operators

Operator

Description

operator ==Compares two object references to see if they refer to the same object.
boolDetermines whether the object exists.
operator !=Compares if two objects refer to a different object.