Struct XMFloat2

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

Implements

IFormattable

IEquatable<XMFloat2>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.DXMath

Assembly: JeremyAnsel.DirectX.DXMath.dll

Syntax

public struct XMFloat2 : IFormattable, IEquatable<XMFloat2>

Constructors

| Edit this page View Source

XMFloat2(ReadOnlySpan<float>)

Initializes a new instance of the XMFloat2 struct.

Declaration

public XMFloat2(ReadOnlySpan<float> array)

Parameters

Type	Name	Description
ReadOnlySpan<float>	array	The components of the vector.

| Edit this page View Source

XMFloat2(float, float)

Initializes a new instance of the XMFloat2 struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "x", Justification = "Reviewed")]
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "y", Justification = "Reviewed")]
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.

| Edit this page View Source

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

| Edit this page View Source

X

Gets or sets the x-coordinate of the vector.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "X", Justification = "Reviewed")]
public float X { get; set; }

Property Value

Type	Description
float

| Edit this page View Source

Y

Gets or sets the y-coordinate of the vector.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Y", Justification = "Reviewed")]
public float Y { get; set; }

Property Value

Type	Description
float

Methods

| Edit this page View Source

Equals(XMFloat2)

Declaration

public readonly bool Equals(XMFloat2 other)

Parameters

Type	Name	Description
XMFloat2	other

Returns

Type	Description
bool

| Edit this page View Source

Equals(object?)

Declaration

public override readonly bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

| Edit this page View Source

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.

| Edit this page View Source

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

| Edit this page View Source

ToString()

Returns the fully qualified type name of this instance.

Declaration

public override readonly string ToString()

Returns

Type	Description
string	The fully qualified type name.

Overrides

ValueType.ToString()

| Edit this page View Source

ToString(string?, IFormatProvider?)

Formats the value of the current instance using the specified format.

Declaration

public readonly string ToString(string? format, IFormatProvider? formatProvider)

Parameters

Type Name Description

Type	Name	Description
string	format	The format to use. -or- A null reference (`Nothing` in Visual Basic) to use the default format defined for the type of the IFormattable implementation.
IFormatProvider	formatProvider	The provider to use to format the value. -or- A null reference (`Nothing` in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

string

format

The format to use.

-or-

A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

IFormatProvider

formatProvider

The provider to use to format the value.

-or-

A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

Type	Description
string	The value of the current instance in the specified format.

| Edit this page View Source

ToVector()

Converts a XMFloat2 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

| Edit this page View Source

operator ==(XMFloat2, XMFloat2)

Declaration

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

Parameters

Type	Name	Description
XMFloat2	left
XMFloat2	right

Returns

Type	Description
bool

| Edit this page View Source

implicit operator XMVector(XMFloat2)

Converts a XMFloat2 to a XMVector.

Declaration

[SuppressMessage("Usage", "CA2225:Les surcharges d'opérateur offrent d'autres méthodes nommées", Justification = "Reviewed.")]
public static implicit operator XMVector(XMFloat2 value)

Parameters

Type	Name	Description
XMFloat2	value	A XMFloat2.

Returns

Type	Description
XMVector	A XMVector.

| Edit this page View Source

implicit operator XMFloat2(XMVector)

Converts a XMVector to a XMFloat2.

Declaration

[SuppressMessage("Usage", "CA2225:Les surcharges d'opérateur offrent d'autres méthodes nommées", Justification = "Reviewed.")]
public static implicit operator XMFloat2(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMFloat2	A XMFloat2.

| Edit this page View Source

operator !=(XMFloat2, XMFloat2)

Declaration

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

Parameters

Type	Name	Description
XMFloat2	left
XMFloat2	right

Returns

Type	Description
bool

Implements

IFormattable

IEquatable<T>