Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

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

Rect.Contains

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

Switch to Manual
public function Contains(point: Vector2): bool;
public bool Contains(Vector2 point);
public function Contains(point: Vector3): bool;
public bool Contains(Vector3 point);
public function Contains(point: Vector3, allowInverse: bool): bool;
public bool Contains(Vector3 point, bool allowInverse);

Parameters

pointPoint to test.
allowInverseDoes the test allow the Rect's width and height to be negative?

Description

Returns true if the x and y components of point is a point inside this rectangle. If allowInverse is present and true, the width and height of the Rect are allowed to take negative values (ie, the min value is greater than the max), and the test will still work.

	// prints inside when mouse is in lower left corner

function Update () { var rect = Rect (0, 0, 150, 150); if (rect.Contains(Input.mousePosition)) print("Inside"); }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Update() { Rect rect = new Rect(0, 0, 150, 150); if (rect.Contains(Input.mousePosition)) print("Inside"); } }