Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Pen

The pointer type for pen events.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Field
  • Namespace: UnityEngine
  • Assembly: UnityEngine.IMGUIModule
Pen = 2

Remarks

Before you process an event as a pen event, you should check the PointerType of a mouse event (e.g. EventType.MouseDown).
When a user uses a pen, some mouse events are often mixed with pen events in the event stream, and you can't distinguish them by type because mouse and pen events share the same EventType. Instead, use PointerType to distinguish them. Otherwise, Unity processes all incoming mouse events as pen events, which can lead to unexpected behavior because the mouse events (pointerType = Mouse) do not have pen event fields, like PenStatus, set.

Examples

using UnityEngine;public class Example : MonoBehaviour{ void OnGUI() { Event m_Event = Event.current; if (m_Event.type == EventType.MouseDown) { if (m_Event.pointerType == PointerType.Pen) //Check if it's a pen event. Debug.Log("Pen Down."); else Debug.Log("Mouse Down.");         //If it's not a pen event, it's a mouse event. } }}