Rect2 Structure

2D axis-aligned bounding box. Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.

Namespace: Godot
Assembly: GodotSharp (in GodotSharp.dll) Version: 1.0.0

Syntax

[SerializableAttribute]
public struct Rect2 : IEquatable<Rect2>

The Rect2 type exposes the following members.

Constructors

	Name	Description
	Rect2(Vector2, Vector2)	Constructs a Rect2 from a position and size.
	Rect2(Single, Single, Vector2)	Constructs a Rect2 from x, y, and size.
	Rect2(Vector2, Single, Single)	Constructs a Rect2 from a position, width, and height.
	Rect2(Single, Single, Single, Single)	Constructs a Rect2 from x, y, width, and height.

Properties

	Name	Description
	Area	The area of this rect.
	End	Ending corner. This is calculated as Position plus Size. Setting this value will change the size.
	Position	Beginning corner. Typically has values lower than End.
	Size	Size from Position to End. Typically all components are positive. If the size is negative, you can use Abs to fix it.

Methods

	Name	Description
	Abs	Returns a Rect2 with equivalent position and size, modified so that the top-left corner is the origin and width and height are positive.
	Clip	Returns the intersection of this Rect2 and `b`.
	Encloses	Returns true if this Rect2 completely encloses another one.
	Equals(Object)	(Overrides ValueTypeEquals(Object).)
	Equals(Rect2)
	Expand	Returns this Rect2 expanded to include a given point.
	GetArea	Returns the area of the Rect2.
	GetHashCode	(Overrides ValueTypeGetHashCode.)
	GetType	(Inherited from Object.)
	Grow	Returns a copy of the Rect2 grown a given amount of units towards all the sides.
	GrowIndividual	Returns a copy of the Rect2 grown a given amount of units towards each direction individually.
	GrowMargin	Returns a copy of the Rect2 grown a given amount of units towards the Margin direction.
	HasNoArea	Returns true if the Rect2 is flat or empty, or false otherwise.
	HasPoint	Returns true if the Rect2 contains a point, or false otherwise.
	Intersects	Returns true if the Rect2 overlaps with `b` (i.e. they have at least one point in common). If `includeBorders` is true, they will also be considered overlapping if their borders touch, even without intersection.
	IsEqualApprox	Returns true if this rect and `other` are approximately equal, by running IsEqualApprox(Vector2) on each component.
	Merge	Returns a larger Rect2 that contains this Rect2 and `b`.
	ToString	(Overrides ValueTypeToString.)
	ToString(String)

Operators

	Name	Description
	Equality
	Inequality