API reference
API reference
Select your platform
No SDKs available
No versions available
PointableCanvasModule Class
Extends PointerInputModule
IPointerInteractableModule manages all InteractableCanvas events in the scene and translates them into pointer events for Unity Canvas UIs.
Events
static Action< PointableCanvasEventArgs > WhenSelected
static Action< PointableCanvasEventArgs > WhenUnselected
static Action< PointableCanvasEventArgs > WhenSelectableHovered
static Action< PointableCanvasEventArgs > WhenSelectableUnhovered
Properties
Protected Fields
bool _started[Get]
Static Member Functions
static void RegisterPointableCanvas
( IPointableCanvas pointerCanvas )
static void UnregisterPointableCanvas
( IPointableCanvas pointerCanvas )
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 ( )
override void Process ( )
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