Struct Rectangle2D
Represents Rectangle2D.
public struct Rectangle2D : IEquatable<Rectangle2D>, ISpanFormattable, IFormattable, ISpanParsable<Rectangle2D>, IParsable<Rectangle2D>
- Implements
- Inherited Members
Constructors
Rectangle2D(Point2D, Point2D)
public Rectangle2D(Point2D start, Point2D end)
Parameters
Rectangle2D(int, int, int, int)
public Rectangle2D(int x, int y, int width, int height)
Parameters
Properties
Empty
public static Rectangle2D Empty { get; }
Property Value
End
public Point2D End { get; set; }
Property Value
Height
public int Height { get; set; }
Property Value
Start
public Point2D Start { get; set; }
Property Value
Width
public int Width { get; set; }
Property Value
X
public int X { get; set; }
Property Value
Y
public int Y { get; set; }
Property Value
Methods
Contains(Point2D)
public bool Contains(Point2D p)
Parameters
pPoint2D
Returns
Contains(Point3D)
public bool Contains(Point3D p)
Parameters
pPoint3D
Returns
Contains(int, int)
public bool Contains(int x, int y)
Parameters
Returns
Equals(Rectangle2D)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(Rectangle2D other)
Parameters
otherRectangle2DAn object to compare with this object.
Returns
Equals(object)
Indicates whether this instance and a specified object are equal.
public override bool Equals(object obj)
Parameters
objobjectThe object to compare with the current instance.
Returns
- bool
true if
objand this instance are the same type and represent the same value; otherwise, false.
GetHashCode()
Returns the hash code for this instance.
public override int GetHashCode()
Returns
- int
A 32-bit signed integer that is the hash code for this instance.
MakeHold(Rectangle2D)
public void MakeHold(Rectangle2D r)
Parameters
Parse(ReadOnlySpan<char>, IFormatProvider)
Parses a span of characters into a value.
public static Rectangle2D Parse(ReadOnlySpan<char> s, IFormatProvider provider)
Parameters
sReadOnlySpan<char>The span of characters to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
s.
Returns
- Rectangle2D
The result of parsing
s.
Exceptions
- FormatException
sis not in the correct format.- OverflowException
sis not representable by Rectangle2D.
Parse(string)
public static Rectangle2D Parse(string s)
Parameters
sstring
Returns
Parse(string, IFormatProvider)
Parses a string into a value.
public static Rectangle2D Parse(string s, IFormatProvider provider)
Parameters
sstringThe string to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
s.
Returns
- Rectangle2D
The result of parsing
s.
Exceptions
- ArgumentNullException
sis null.- FormatException
sis not in the correct format.- OverflowException
sis not representable by Rectangle2D.
Set(int, int, int, int)
public void Set(int x, int y, int width, int height)
Parameters
ToString()
Returns the fully qualified type name of this instance.
public override string ToString()
Returns
- string
The fully qualified type name.
ToString(string, IFormatProvider)
Formats the value of the current instance using the specified format.
public string ToString(string format, IFormatProvider formatProvider)
Parameters
formatstringThe format to use.
-or-
A null reference (
Nothingin Visual Basic) to use the default format defined for the type of the IFormattable implementation.formatProviderIFormatProviderThe provider to use to format the value.
-or-
A null reference (
Nothingin Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.
Returns
- string
The value of the current instance in the specified format.
TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider)
Tries to format the value of the current instance into the provided span of characters.
public bool TryFormat(Span<char> destination, out int charsWritten, ReadOnlySpan<char> format, IFormatProvider provider)
Parameters
destinationSpan<char>The span in which to write this instance's value formatted as a span of characters.
charsWrittenintWhen this method returns, contains the number of characters that were written in
destination.formatReadOnlySpan<char>A span containing the characters that represent a standard or custom format string that defines the acceptable format for
destination.providerIFormatProviderAn optional object that supplies culture-specific formatting information for
destination.
Returns
TryParse(ReadOnlySpan<char>, IFormatProvider, out Rectangle2D)
Tries to parse a span of characters into a value.
public static bool TryParse(ReadOnlySpan<char> s, IFormatProvider provider, out Rectangle2D result)
Parameters
sReadOnlySpan<char>The span of characters to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
s.resultRectangle2DWhen this method returns, contains the result of successfully parsing
s, or an undefined value on failure.
Returns
TryParse(string, IFormatProvider, out Rectangle2D)
Tries to parse a string into a value.
public static bool TryParse(string s, IFormatProvider provider, out Rectangle2D result)
Parameters
sstringThe string to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
s.resultRectangle2DWhen this method returns, contains the result of successfully parsing
sor an undefined value on failure.
Returns
Operators
operator ==(Rectangle2D, Rectangle2D)
public static bool operator ==(Rectangle2D l, Rectangle2D r)
Parameters
Returns
operator !=(Rectangle2D, Rectangle2D)
public static bool operator !=(Rectangle2D l, Rectangle2D r)