Struct XMFloat2

A 2D vector consisting of two single-precision floating-point values.

Implements

IEquatable<XMFloat2>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.DXMath

Assembly: JeremyAnsel.DirectX.DXMath.dll

Syntax

public struct XMFloat2 : IEquatable<XMFloat2>

Constructors

XMFloat2(float, float)

Initializes a new instance of the XMFloat2 struct.

Declaration

public XMFloat2(float x, float y)

Parameters

Type	Name	Description
float	x	The x-coordinate of the vector.
float	y	The y-coordinate of the vector.

XMFloat2(float[])

Initializes a new instance of the XMFloat2 struct.

Declaration

public XMFloat2(float[] array)

Parameters

Type	Name	Description
float[]	array	The components of the vector.

Properties

X

Gets or sets the x-coordinate of the vector.

Declaration

public float X { get; set; }

Property Value

Type	Description
float

Y

Gets or sets the y-coordinate of the vector.

Declaration

public float Y { get; set; }

Property Value

Type	Description
float

Methods

Equals(XMFloat2)

Determines whether the specified object is equal to the current object.

Declaration

public bool Equals(XMFloat2 other)

Parameters

Type	Name	Description
XMFloat2	other	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueType.Equals(object)

FromVector(XMVector)

Converts a XMVector to a XMFloat2.

Declaration

public static XMFloat2 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMFloat2	A XMFloat2.

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

ToVector()

Converts a XMFloat2 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

operator ==(XMFloat2, XMFloat2)

Compares two XMFloat2 objects. The result specifies whether the values of the two objects are equal.

Declaration

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

Parameters

Type	Name	Description
XMFloat2	left	The left XMFloat2 to compare.
XMFloat2	right	The right XMFloat2 to compare.

Returns

Type	Description
bool	true if the values of left and right are equal; otherwise, false.

implicit operator XMVector(XMFloat2)

Converts a XMFloat2 to a XMVector.

Declaration

public static implicit operator XMVector(XMFloat2 value)

Parameters

Type	Name	Description
XMFloat2	value	A XMFloat2.

Returns

Type	Description
XMVector	A XMVector.

implicit operator XMFloat2(XMVector)

Converts a XMVector to a XMFloat2.

Declaration

public static implicit operator XMFloat2(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMFloat2	A XMFloat2.

operator !=(XMFloat2, XMFloat2)

Compares two XMFloat2 objects. The result specifies whether the values of the two objects are unequal.

Declaration

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

Parameters

Type	Name	Description
XMFloat2	left	The left XMFloat2 to compare.
XMFloat2	right	The right XMFloat2 to compare.

Returns

Type	Description
bool	true if the values of left and right differ; otherwise, false.

Implements

IEquatable<T>