Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


HitTest

Is a point on screen inside the element?
Read time 2 minutesLast updated 12 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.IMGUIModule

HitTest(Vector3)

Is a point on screen inside the element?
public bool HitTest(Vector3 screenPosition)

Parameters

screenPosition

Returns

Type

Description

bool

Remarks

Returns true if the
screenPosition
is contained in this GUIElement.
screenPosition
is specified in screen coordinates, like the values returned by the Input.mousePosition property. If no
camera
is given a camera filling the entire game window will be assumed.
Note that if the position is inside the element,
true
will be returned even if the game object belongs to Ignore Raycast layer (normally mouse events are not sent to Ignore Raycast objects).
Additional Resources: HitTest.

HitTest(Vector3, Camera)

Is a point on screen inside the element?
public bool HitTest(Vector3 screenPosition, Camera camera)

Parameters

screenPosition


camera

Returns

Type

Description

bool

Remarks

Returns true if the
screenPosition
is contained in this GUIElement.
screenPosition
is specified in screen coordinates, like the values returned by the Input.mousePosition property. If no
camera
is given a camera filling the entire game window will be assumed.
Note that if the position is inside the element,
true
will be returned even if the game object belongs to Ignore Raycast layer (normally mouse events are not sent to Ignore Raycast objects).
Additional Resources: HitTest.