Struct XMInt3

A 3D vector where each component is a signed integer.

Implements

IFormattable

IEquatable<XMInt3>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.DXMath

Assembly: JeremyAnsel.DirectX.DXMath.dll

Syntax

public struct XMInt3 : IFormattable, IEquatable<XMInt3>

Constructors

XMInt3(int, int, int)

Initializes a new instance of the XMInt3 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 XMInt3(int x, int y, int z)

Parameters

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

XMInt3(int[]?)

Initializes a new instance of the XMInt3 struct.

Declaration

public XMInt3(int[]? array)

Parameters

Type	Name	Description
int[]	array	The components of the array.

XMInt3(ReadOnlySpan<int>)

Initializes a new instance of the XMInt3 struct.

Declaration

public XMInt3(ReadOnlySpan<int> array)

Parameters

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

Properties

X

Gets or sets the x-coordinate of the vector.

Declaration

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

Property Value

Type	Description
int

Y

Gets or sets the y-coordinate of the vector.

Declaration

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

Property Value

Type	Description
int

Z

Gets or sets the z-coordinate of the vector.

Declaration

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

Property Value

Type	Description
int

Methods

Equals(XMInt3)

Declaration

public readonly bool Equals(XMInt3 other)

Parameters

Type	Name	Description
XMInt3	other

Returns

Type	Description
bool

Equals(object?)

Declaration

public override readonly bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

FromVector(XMVector)

Converts a XMVector to a XMInt3.

Declaration

public static XMInt3 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMInt3	A XMInt3.

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

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 XMInt3 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

operator ==(XMInt3, XMInt3)

Declaration

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

Parameters

Type	Name	Description
XMInt3	left
XMInt3	right

Returns

Type	Description
bool

implicit operator XMVector(XMInt3)

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

Parameters

Type	Name	Description
XMInt3	value	A XMInt3.

Returns

Type	Description
XMVector	A XMVector.

implicit operator XMInt3(XMVector)

Converts a XMVector to a XMInt3.

Declaration

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

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMInt3	A XMInt3.

operator !=(XMInt3, XMInt3)

Declaration

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

Parameters

Type	Name	Description
XMInt3	left
XMInt3	right

Returns

Type	Description
bool

Implements

IFormattable

IEquatable<T>