LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

GUIElement.HitTest

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public function HitTest(screenPosition: Vector3, camera: Camera = null): bool;
public bool HitTest(Vector3 screenPosition, Camera camera = null);
public function HitTest(screenPosition: Vector3, camera: Camera = null): bool;
public bool HitTest(Vector3 screenPosition, Camera camera = null);

Parameters

Description

Is a point on screen inside the element?

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).

See Also: GUILayer.HitTest.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download