Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Contains

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.
Read time 4 minutesLast updated 5 days ago

Definition

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

Contains(Vector2)

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.
public readonly bool Contains(Vector2 point)

Parameters

point

Point to test.

Returns

Type

Description

boolTrue if the point lies within the specified rectangle.

Examples

using UnityEngine;public class RectExample : MonoBehaviour{ void Update() { Rect rect = new Rect(0, 0, 150, 150); if (rect.Contains(Input.mousePosition)) Debug.Log("Inside"); }}

Contains(Vector2)

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.
public readonly bool Contains(in Vector2 point)

Parameters

point

Point to test.

Returns

Type

Description

boolTrue if the point lies within the specified rectangle.

Examples

using UnityEngine;public class RectExample : MonoBehaviour{ void Update() { Rect rect = new Rect(0, 0, 150, 150); if (rect.Contains(Input.mousePosition)) Debug.Log("Inside"); }}

Contains(Vector3)

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.
public readonly bool Contains(Vector3 point)

Parameters

point

Point to test.

Returns

Type

Description

boolTrue if the point lies within the specified rectangle.

Examples

using UnityEngine;public class RectExample : MonoBehaviour{ void Update() { Rect rect = new Rect(0, 0, 150, 150); if (rect.Contains(Input.mousePosition)) Debug.Log("Inside"); }}

Contains(Vector3)

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.
public readonly bool Contains(in Vector3 point)

Parameters

point

Point to test.

Returns

Type

Description

boolTrue if the point lies within the specified rectangle.

Examples

using UnityEngine;public class RectExample : MonoBehaviour{ void Update() { Rect rect = new Rect(0, 0, 150, 150); if (rect.Contains(Input.mousePosition)) Debug.Log("Inside"); }}

Contains(Vector3, bool)

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.
public readonly bool Contains(Vector3 point, bool allowInverse)

Parameters

point

Point to test.

allowInverse

Does the test allow the Rect's width and height to be negative?

Returns

Type

Description

boolTrue if the point lies within the specified rectangle.

Examples

using UnityEngine;public class RectExample : MonoBehaviour{ void Update() { Rect rect = new Rect(0, 0, 150, 150); if (rect.Contains(Input.mousePosition)) Debug.Log("Inside"); }}

Contains(Vector3, bool)

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.
public readonly bool Contains(in Vector3 point, bool allowInverse)

Parameters

point

Point to test.

allowInverse

Does the test allow the Rect's width and height to be negative?

Returns

Type

Description

boolTrue if the point lies within the specified rectangle.

Examples

using UnityEngine;public class RectExample : MonoBehaviour{ void Update() { Rect rect = new Rect(0, 0, 150, 150); if (rect.Contains(Input.mousePosition)) Debug.Log("Inside"); }}