Struct PointF

Represents an ordered pair of single precision floating point x- and y-coordinates that defines a point in a two-dimensional plane.

Implements

IEquatable<PointF>

Namespace: SixLabors.ImageSharp

Assembly: SixLabors.ImageSharp.dll

Syntax

public struct PointF

Remarks

This struct is fully mutable. This is done (against the guidelines) for the sake of performance, as it avoids the need to create new values for modification operations.

Constructors

| Improve this Doc View Source

PointF(SizeF)

Initializes a new instance of the PointF struct from the given SizeF.

Declaration

public PointF(SizeF size)

Parameters

Type	Name	Description
SizeF	size	The size.

| Improve this Doc View Source

PointF(Single, Single)

Initializes a new instance of the PointF struct.

Declaration

public PointF(float x, float y)

Parameters

Type	Name	Description
Single	x	The horizontal position of the point.
Single	y	The vertical position of the point.

Fields

| Improve this Doc View Source

Empty

Represents a PointF that has X and Y values set to zero.

Declaration

public static readonly PointF Empty

Field Value

Type	Description
PointF

Properties

| Improve this Doc View Source

IsEmpty

Gets a value indicating whether this PointF is empty.

Declaration

public readonly bool IsEmpty { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

X

Gets or sets the x-coordinate of this PointF.

Declaration

public float X { readonly get; set; }

Property Value

Type	Description
Single

| Improve this Doc View Source

Y

Gets or sets the y-coordinate of this PointF.

Declaration

public float Y { readonly get; set; }

Property Value

Type	Description
Single

Methods

| Improve this Doc View Source

Add(PointF, PointF)

Translates a PointF by the given PointF.

Declaration

public static PointF Add(PointF point, PointF pointb)

Parameters

Type	Name	Description
PointF	point	The point on the left hand of the operand.
PointF	pointb	The point on the right hand of the operand.

Returns

Type	Description
PointF	The PointF.

| Improve this Doc View Source

Add(PointF, SizeF)

Translates a PointF by the given SizeF.

Declaration

public static PointF Add(PointF point, SizeF size)

Parameters

Type	Name	Description
PointF	point	The point on the left hand of the operand.
SizeF	size	The size on the right hand of the operand.

Returns

Type	Description
PointF	The PointF.

| Improve this Doc View Source

Deconstruct(out Single, out Single)

Deconstructs this point into two floats.

Declaration

public void Deconstruct(out float x, out float y)

Parameters

Type	Name	Description
Single	x	The out value for X.
Single	y	The out value for Y.

| Improve this Doc View Source

Equals(PointF)

Declaration

public bool Equals(PointF other)

Parameters

Type	Name	Description
PointF	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(Nullable<Object>)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
Nullable<Object>	obj

Returns

Type	Description
Boolean

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

| Improve this Doc View Source

Multiply(PointF, Single)

Translates a PointF by the multiplying the X and Y by the given value.

Declaration

public static PointF Multiply(PointF point, float right)

Parameters

Type	Name	Description
PointF	point	The point on the left hand of the operand.
Single	right	The value on the right hand of the operand.

Returns

Type	Description
PointF	The PointF.

| Improve this Doc View Source

Offset(PointF)

Translates this PointF by the specified amount.

Declaration

public void Offset(PointF point)

Parameters

Type	Name	Description
PointF	point	The PointF used offset this PointF.

| Improve this Doc View Source

Offset(Single, Single)

Translates this PointF by the specified amount.

Declaration

public void Offset(float dx, float dy)

Parameters

Type	Name	Description
Single	dx	The amount to offset the x-coordinate.
Single	dy	The amount to offset the y-coordinate.

| Improve this Doc View Source

Subtract(PointF, PointF)

Translates a PointF by the negative of a given PointF.

Declaration

public static PointF Subtract(PointF point, PointF pointb)

Parameters

Type	Name	Description
PointF	point	The point on the left hand of the operand.
PointF	pointb	The point on the right hand of the operand.

Returns

Type	Description
PointF	The PointF.

| Improve this Doc View Source

Subtract(PointF, SizeF)

Translates a PointF by the negative of a given SizeF.

Declaration

public static PointF Subtract(PointF point, SizeF size)

Parameters

Type	Name	Description
PointF	point	The point on the left hand of the operand.
SizeF	size	The size on the right hand of the operand.

Returns

Type	Description
PointF	The PointF.

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

| Improve this Doc View Source

Transform(PointF, Matrix3x2)

Transforms a point by a specified 3x2 matrix.

Declaration

public static PointF Transform(PointF point, Matrix3x2 matrix)

Parameters

Type	Name	Description
PointF	point	The point to transform.
Matrix3x2	matrix	The transformation matrix used.

Returns

Type	Description
PointF	The transformed PointF.

Operators

| Improve this Doc View Source

Addition(PointF, PointF)

Translates a PointF by a given SizeF.

Declaration

public static PointF operator +(PointF point, PointF size)

Parameters

Type	Name	Description
PointF	point	The point on the left hand of the operand.
PointF	size	The size on the right hand of the operand.

Returns

Type	Description
PointF	The PointF.

| Improve this Doc View Source

Addition(PointF, SizeF)

Translates a PointF by a given SizeF.

Declaration

public static PointF operator +(PointF point, SizeF size)

Parameters

Type	Name	Description
PointF	point	The point on the left hand of the operand.
SizeF	size	The size on the right hand of the operand.

Returns

Type	Description
PointF	The PointF.

| Improve this Doc View Source

Division(PointF, Single)

Divides PointF by a producing SizeF.

Declaration

public static PointF operator /(PointF left, float right)

Parameters

Type	Name	Description
PointF	left	Dividend of type PointF.
Single	right	Divisor of type .

Returns

Type	Description
PointF	Result of type PointF.

| Improve this Doc View Source

Equality(PointF, PointF)

Compares two PointF objects for equality.

Declaration

public static bool operator ==(PointF left, PointF right)

Parameters

Type	Name	Description
PointF	left	The PointF on the left side of the operand.
PointF	right	The PointF on the right side of the operand.

Returns

Type	Description
Boolean	True if the current left is equal to the `right` parameter; otherwise, false.

| Improve this Doc View Source

Explicit(PointF to Point)

Creates a Point with the coordinates of the specified PointF by truncating each of the coordinates.

Declaration

public static explicit operator Point(PointF point)

Parameters

Type	Name	Description
PointF	point	The point.

Returns

Type	Description
Point	The Point.

| Improve this Doc View Source

Implicit(PointF to Vector2)

Creates a with the coordinates of the specified PointF.

Declaration

public static implicit operator Vector2(PointF point)

Parameters

Type	Name	Description
PointF	point	The point.

Returns

Type	Description
Vector2	The .

| Improve this Doc View Source

Implicit(Vector2 to PointF)

Creates a with the coordinates of the specified PointF.

Declaration

public static implicit operator PointF(Vector2 vector)

Parameters

Type	Name	Description
Vector2	vector	The vector.

Returns

Type	Description
PointF	The .

| Improve this Doc View Source

Inequality(PointF, PointF)

Compares two PointF objects for inequality.

Declaration

public static bool operator !=(PointF left, PointF right)

Parameters

Type	Name	Description
PointF	left	The PointF on the left side of the operand.
PointF	right	The PointF on the right side of the operand.

Returns

Type	Description
Boolean	True if the current left is unequal to the `right` parameter; otherwise, false.

| Improve this Doc View Source

Multiply(PointF, Single)

Multiplies PointF by a producing SizeF.

Declaration

public static PointF operator *(PointF left, float right)

Parameters

Type	Name	Description
PointF	left	Multiplicand of type PointF.
Single	right	Multiplier of type .

Returns

Type	Description
PointF	Product of type SizeF.

| Improve this Doc View Source

Multiply(Single, PointF)

Multiplies PointF by a producing SizeF.

Declaration

public static PointF operator *(float left, PointF right)

Parameters

Type	Name	Description
Single	left	Multiplier of type .
PointF	right	Multiplicand of type SizeF.

Returns

Type	Description
PointF	Product of type SizeF.

| Improve this Doc View Source

Subtraction(PointF, PointF)

Translates a PointF by the negative of a given SizeF.

Declaration

public static PointF operator -(PointF point, PointF size)

Parameters

Type	Name	Description
PointF	point	The point on the left hand of the operand.
PointF	size	The size on the right hand of the operand.

Returns

Type	Description
PointF	The PointF.

| Improve this Doc View Source

Subtraction(PointF, SizeF)

Translates a PointF by the negative of a given SizeF.

Declaration

public static PointF operator -(PointF point, SizeF size)

Parameters

Type	Name	Description
PointF	point	The point on the left hand of the operand.
SizeF	size	The size on the right hand of the operand.

Returns

Type	Description
PointF	The PointF.

| Improve this Doc View Source

UnaryNegation(PointF)

Negates the given point by multiplying all values by -1.

Declaration

public static PointF operator -(PointF value)

Parameters

Type	Name	Description
PointF	value	The source point.

Returns

Type	Description
PointF	The negated point.

Implements

IEquatable<>