Struct XMUShortN2

A 2D vector for storing unsigned, normalized values as unsigned 16-bit integers.

Implements

IEquatable<XMUShortN2>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.DXMath.PackedVector

Assembly: JeremyAnsel.DirectX.DXMath.dll

Syntax

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

Constructors

| Edit this page View Source

XMUShortN2(ReadOnlySpan<float>)

Initializes a new instance of the XMUShortN2 struct.

Declaration

public XMUShortN2(ReadOnlySpan<float> array)

Parameters

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

| Edit this page View Source

XMUShortN2(ReadOnlySpan<ushort>)

Initializes a new instance of the XMUShortN2 struct.

Declaration

public XMUShortN2(ReadOnlySpan<ushort> array)

Parameters

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

| Edit this page View Source

XMUShortN2(float, float)

Initializes a new instance of the XMUShortN2 struct.

Declaration

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

XMUShortN2(float[])

Initializes a new instance of the XMUShortN2 struct.

Declaration

public XMUShortN2(float[] array)

Parameters

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

| Edit this page View Source

XMUShortN2(ushort, ushort)

Initializes a new instance of the XMUShortN2 struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "x", Justification = "Reviewed")]
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "y", Justification = "Reviewed")]
public XMUShortN2(ushort x, ushort y)

Parameters

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

| Edit this page View Source

XMUShortN2(ushort[])

Initializes a new instance of the XMUShortN2 struct.

Declaration

public XMUShortN2(ushort[] array)

Parameters

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

| Edit this page View Source

XMUShortN2(uint)

Initializes a new instance of the XMUShortN2 struct.

Declaration

public XMUShortN2(uint packed)

Parameters

Type	Name	Description
uint	packed	A packed value representing 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 ushort X { get; set; }

Property Value

Type	Description
ushort

| Edit this page View Source

Y

Gets or sets the x-coordinate of the vector.

Declaration

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

Property Value

Type	Description
ushort

Methods

| Edit this page View Source

Equals(XMUShortN2)

Declaration

public readonly bool Equals(XMUShortN2 other)

Parameters

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

Declaration

public static XMUShortN2 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUShortN2	A XMUShortN2.

| Edit this page View Source

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

| Edit this page View Source

ToVector()

Converts a XMUShortN2 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

| Edit this page View Source

operator ==(XMUShortN2, XMUShortN2)

Declaration

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

Parameters

Type	Name	Description
XMUShortN2	left
XMUShortN2	right

Returns

Type	Description
bool

| Edit this page View Source

implicit operator XMVector(XMUShortN2)

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

Parameters

Type	Name	Description
XMUShortN2	value	A XMUShortN2.

Returns

Type	Description
XMVector	A XMVector.

| Edit this page View Source

implicit operator XMUShortN2(XMVector)

Converts a XMVector to a XMUShortN2.

Declaration

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

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUShortN2	A XMUShortN2.

| Edit this page View Source

operator !=(XMUShortN2, XMUShortN2)

Declaration

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

Parameters

Type	Name	Description
XMUShortN2	left
XMUShortN2	right

Returns

Type	Description
bool

Implements

IEquatable<T>