API reference
PointableCanvasModule Class
Extends PointerInputModule
PointableCanvasModule is a context-like object which exists in the scene and handles routing for certain types of PointerEvents, translating them into Unity pointer events which can be routed to and consumed by Unity Canvases.
PointableCanvas requires that the scene contain a PointableCanvasModule.
Events
static Action< PointableCanvasEventArgs > WhenSelected
Global event invoked in response to a PointerEventType.Select on an IPointableCanvas.
Though this event itself is static, it is invoked by the PointableCanvasModule instance in the scene as part of Process.
static Action< PointableCanvasEventArgs > WhenUnselected
Global event invoked in response to a PointerEventType.Unselect on an IPointableCanvas.
Though this event itself is static, it is invoked by the PointableCanvasModule instance in the scene as part of Process.
static Action< PointableCanvasEventArgs > WhenSelectableHovered
Global event invoked in response to a PointerEventType.Hover on an IPointableCanvas.
Though this event itself is static, it is invoked by the PointableCanvasModule instance in the scene as part of Process.
static Action< PointableCanvasEventArgs > WhenSelectableUnhovered
Global event invoked in response to a PointerEventType.Unhover on an IPointableCanvas.
Though this event itself is static, it is invoked by the PointableCanvasModule instance in the scene as part of Process.
static Action< Pointer > WhenPointerStarted
Global event invoked whenever a new Pointer is started.
Though this event itself is static, it is invoked by the PointableCanvasModule instance in the scene as part of Process.
Properties
bool ExclusiveMode[Get]
If true, this module will disable other input modules in the event system and will be the only input module used in the scene.
static PointableCanvasModule Instance[Get]
Protected Fields
bool _started[Get]
Static Member Functions
static void RegisterPointableCanvas
( IPointableCanvas pointerCanvas )
Registers an IPointableCanvas with the PointableCanvasModule in the scene so that its PointerEvents can be correctly handled, converted, and forwarded.
Parameters
pointerCanvas
The IPointableCanvas to register
static void UnregisterPointableCanvas
( IPointableCanvas pointerCanvas )
Unregisters an IPointableCanvas with the PointableCanvasModule in the scene.
PointerEvents from that canvas will no longer be propagated to the Unity Canvas.
Parameters
pointerCanvas
The IPointableCanvas to unregister
Protected Functions
override void Awake ( )
override void OnDestroy ( )
override void Start ( )
override void OnEnable ( )
override void OnDisable ( )
void UpdatePointerEventData
( PointerEventData pointerEvent,
bool pressed,
bool released )
This method is based on ProcessTouchPoint in StandaloneInputModule, but is instead used for Pointer events
override void ProcessDrag
( PointerEventData pointerEvent )
Override of PointerInputModule's ProcessDrag to allow using the initial press position for drag begin.
Set _useInitialPressPositionForDrag to false if you prefer the default behaviour of PointerInputModule.
Member Functions
override void UpdateModule ( )
This is an internal API which is invoked to update the PointableCanvasModule.
This overrides the UpdateModule() method of Unity's BaseInputModule, from which PointableCanvasModule is descended, and should not be invoked directly.
override void Process ( )
This is an internal API which is invoked to process input.
This overrides the Process() method of Unity's BaseInputModule, from which PointableCanvasModule is descended, and should not be invoked manually.
Object Data for protected-static-func
static RaycastResult FindFirstRaycastWithinCanvas
( List< RaycastResult > candidates,
Canvas canvas )
static bool ShouldStartDrag
( Vector2 pressPos,
Vector2 currentPos,
float threshold,
bool useDragThreshold )
Used in PointerInputModule's ProcessDrag implementation.
Brought into this subclass with a protected signature (as opposed to the parent's private signature) to be used in this subclass's overridden ProcessDrag.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta