LanguageEnglish
  • C#
  • JS

Script language

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

Rect

struct in UnityEngine

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

Description

A 2D Rectangle defined by X and Y position, width and height.

Unity uses a number of 2D coordinate spaces, most of which define X as increasing to the right, and Y increasing upwards. The one exception is in the GUI and GUILayout classes, where Y increases downwards.

The following examples are illustrated in GUI space, where (0,0) represents the top-left corner and Y increases downwards.

Rectangles can be specified in two different ways. The first is with an x and y position and a width and height:

The other way is with the X and Y coordinates of each of its edges. These are called xMin, xMax, yMin and yMax:



Note that although x and y have the same values as xMin and yMin, they behave differently when you set them. Setting x or y changes the position of the rectangle, but preserves its size:



Setting any of xMin, xMax, yMin and yMax will resize the rectangle, but preserve the position of the opposite edge:



See Also: GUI Scripting Guide, Camera.rect, Camera.pixelRect.

Variables

centerThe position of the center of the rectangle.
heightThe height of the rectangle, measured from the Y position.
maxThe position of the maximum corner of the rectangle.
minThe position of the minimum corner of the rectangle.
positionThe X and Y position of the rectangle.
sizeThe width and height of the rectangle.
widthThe width of the rectangle, measured from the X position.
xThe X coordinate of the rectangle.
xMaxThe maximum X coordinate of the rectangle.
xMinThe minimum X coordinate of the rectangle.
yThe Y coordinate of the rectangle.
yMaxThe maximum Y coordinate of the rectangle.
yMinThe minimum Y coordinate of the rectangle.

Constructors

RectCreates a new rectangle.

Public Functions

ContainsReturns 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.
OverlapsReturns true if the other rectangle overlaps this one. If allowInverse is present and true, the widths and heights of the Rects are allowed to take negative values (ie, the min value is greater than the max), and the test will still work.
SetSet components of an existing Rect.
ToStringReturns a nicely formatted string for this Rect.

Static Functions

MinMaxRectCreates a rectangle from min/max coordinate values.
NormalizedToPointReturns a point inside a rectangle, given normalized coordinates.
PointToNormalizedReturns the normalized coordinates cooresponding the the point.

Operators

operator !=Returns true if the rectangles are different.
operator ==Returns true if the rectangles are the same.