Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


RectInt

A 2D Rectangle defined by x, y, width, height with integers.
Read time 2 minutesLast updated 4 days ago

Definition

public struct RectInt : IEquatable<RectInt>, IFormattable

Constructors

Properties

Property

Description

allPositionsWithinA PositionCollection that contains all positions within the RectInt.
centerCenter coordinate of the rectangle.
heightHeight of the rectangle.
maxThe upper right corner of the rectangle; which is the maximal position of the rectangle along the x- and y-axes, when it is aligned to both axes.
minThe lower left corner of the rectangle; which is the minimal position of the rectangle along the x- and y-axes, when it is aligned to both axes.
positionReturns the position (x, y) of the
RectInt
.
sizeReturns the width and height of the
RectInt
.
widthWidth of the rectangle.
xLeft coordinate of the rectangle.
xMaxShows the maximum X value of the
RectInt
.
xMinShows the minimum X value of the
RectInt
.
yTop coordinate of the rectangle.
yMaxShows the maximum Y value of the
RectInt
.
yMinShow the minimum Y value of the
RectInt
.

Static Properties

Property

Description

zeroShorthand for writing
new RectInt(0,0,0,0)
.

Methods

Method

Description

ClampToBoundsClamps the position and size of the
RectInt
to the given bounds.
ContainsReturns true if the given position is within the RectInt.
EqualsReturns true if the given RectInt is equal to this RectInt.
OverlapsRectInts overlap if each RectInt RectInt.Contains a shared point.
SetMinMaxSets the bounds to the
min
and
max
value of the rect.
ToStringReturns the x, y, width and height of the
RectInt
.

Operators

Operator

Description

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

Structs

Struct

Description

RectInt.PositionEnumeratorAn iterator that allows you to iterate over all positions within the RectInt.