struct in UnityEngine
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseA 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:
Additional resources: GUI Scripting Guide, Camera.rect, Camera.pixelRect.
zero | Shorthand for writing new Rect(0,0,0,0). |
center | The position of the center of the rectangle. |
height | The height of the rectangle, measured from the Y position. |
max | The position of the maximum corner of the rectangle. |
min | The position of the minimum corner of the rectangle. |
position | The X and Y position of the rectangle. |
size | The width and height of the rectangle. |
width | The width of the rectangle, measured from the X position. |
x | The X coordinate of the rectangle. |
xMax | The maximum X coordinate of the rectangle. |
xMin | The minimum X coordinate of the rectangle. |
y | The Y coordinate of the rectangle. |
yMax | The maximum Y coordinate of the rectangle. |
yMin | The minimum Y coordinate of the rectangle. |
Rect | Creates a new rectangle. |
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. |
Overlaps | Returns 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. |
Set | Set components of an existing Rect. |
ToString | Returns a formatted string for this Rect. |
MinMaxRect | Creates a rectangle from min/max coordinate values. |
NormalizedToPoint | Returns a point inside a rectangle, given normalized coordinates. |
PointToNormalized | Returns the normalized coordinates cooresponding the the point. |
operator == | Returns true if the rectangles are the same. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.