Struct XMFloat4

A 4D vector consisting of four single-precision floating-point values.

Implements

IEquatable<XMFloat4>

IFormattable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.DXMath

Assembly: JeremyAnsel.DirectX.DXMath.dll

Syntax

public struct XMFloat4 : IEquatable<XMFloat4>, IFormattable

Constructors

| Edit this page View Source

XMFloat4(float, float, float, float)

Initializes a new instance of the XMFloat4 struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "x", Justification = "Reviewed")]
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "y", Justification = "Reviewed")]
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "z", Justification = "Reviewed")]
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "w", Justification = "Reviewed")]
public XMFloat4(float x, float y, float z, float w)

Parameters

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

| Edit this page View Source

XMFloat4(float[]?)

Initializes a new instance of the XMFloat4 struct.

Declaration

public XMFloat4(float[]? array)

Parameters

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

Properties

| Edit this page View Source

W

Gets or sets the w-coordinate of the vector.

Declaration

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

Property Value

Type	Description
float

| 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

| Edit this page View Source

Z

Gets or sets the z-coordinate of the vector.

Declaration

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

Property Value

Type	Description
float

Methods

| Edit this page View Source

Equals(XMFloat4)

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

Declaration

public bool Equals(XMFloat4 other)

Parameters

Type	Name	Description
XMFloat4	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.

| Edit this page View Source

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)

| Edit this page View Source

FromVector(XMVector)

Converts a XMVector to a XMFloat4.

Declaration

public static XMFloat4 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMFloat4	A XMFloat4.

| Edit this page View Source

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()

| Edit this page View Source

ToString()

Returns the fully qualified type name of this instance.

Declaration

public override 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 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 XMFloat4 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

| Edit this page View Source

operator ==(XMFloat4, XMFloat4)

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

Declaration

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

Parameters

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

Returns

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

| Edit this page View Source

implicit operator XMVector(XMFloat4)

Converts a XMFloat4 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(XMFloat4 value)

Parameters

Type	Name	Description
XMFloat4	value	A XMFloat4.

Returns

Type	Description
XMVector	A XMVector.

| Edit this page View Source

implicit operator XMFloat4(XMVector)

Converts a XMVector to a XMFloat4.

Declaration

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

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMFloat4	A XMFloat4.

| Edit this page View Source

operator !=(XMFloat4, XMFloat4)

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

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>

IFormattable