Struct XMUInt3

A 3D vector where each component is an unsigned integer.

Implements

IEquatable<XMUInt3>

IFormattable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.DXMath

Assembly: JeremyAnsel.DirectX.DXMath.dll

Syntax

[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "XMU", Justification = "Reviewed")]
public struct XMUInt3 : IEquatable<XMUInt3>, IFormattable

Constructors

XMUInt3(uint, uint, uint)

Initializes a new instance of the XMUInt3 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")]
public XMUInt3(uint x, uint y, uint z)

Parameters

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

XMUInt3(uint[]?)

Initializes a new instance of the XMUInt3 struct.

Declaration

public XMUInt3(uint[]? array)

Parameters

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

Properties

X

Gets or sets the x-coordinate of the vector.

Declaration

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

Property Value

Type	Description
uint

Y

Gets or sets the y-coordinate of the vector.

Declaration

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

Property Value

Type	Description
uint

Z

Gets or sets the z-coordinate of the vector.

Declaration

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

Property Value

Type	Description
uint

Methods

Equals(XMUInt3)

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

Declaration

public bool Equals(XMUInt3 other)

Parameters

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

Declaration

public static XMUInt3 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUInt3	A XMUInt3.

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

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

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
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.

ToVector()

Converts a XMUInt3 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

operator ==(XMUInt3, XMUInt3)

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

Declaration

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

Parameters

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

Returns

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

implicit operator XMVector(XMUInt3)

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

Parameters

Type	Name	Description
XMUInt3	value	A XMUInt3.

Returns

Type	Description
XMVector	A XMVector.

implicit operator XMUInt3(XMVector)

Converts a XMVector to a XMUInt3.

Declaration

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

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUInt3	A XMUInt3.

operator !=(XMUInt3, XMUInt3)

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

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>

IFormattable