Struct XMUDecN4

A 4D vector for storing unsigned, normalized integer values as 10 bit unsigned x-, y-, and z-components and a 2-bit unsigned w-component.

Implements

IEquatable<XMUDecN4>

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 XMUDecN4 : IEquatable<XMUDecN4>

Constructors

| Edit this page View Source

XMUDecN4(ReadOnlySpan<float>)

Initializes a new instance of the XMUDecN4 struct.

Declaration

public XMUDecN4(ReadOnlySpan<float> array)

Parameters

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

| Edit this page View Source

XMUDecN4(float, float, float, float)

Initializes a new instance of the XMUDecN4 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 XMUDecN4(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

XMUDecN4(float[])

Initializes a new instance of the XMUDecN4 struct.

Declaration

public XMUDecN4(float[] array)

Parameters

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

| Edit this page View Source

XMUDecN4(uint)

Initializes a new instance of the XMUDecN4 struct.

Declaration

public XMUDecN4(uint packed)

Parameters

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

Property Value

Type	Description
uint

| 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 uint X { get; set; }

Property Value

Type	Description
uint

| 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 uint Y { get; set; }

Property Value

Type	Description
uint

| 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 uint Z { get; set; }

Property Value

Type	Description
uint

Methods

| Edit this page View Source

Equals(XMUDecN4)

Declaration

public readonly bool Equals(XMUDecN4 other)

Parameters

Type	Name	Description
XMUDecN4	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

FromPacked(uint)

Converts a packed value to a XMUDecN4.

Declaration

public static XMUDecN4 FromPacked(uint value)

Parameters

Type	Name	Description
uint	value	A packed value.

Returns

Type	Description
XMUDecN4	A XMUDecN4.

| Edit this page View Source

FromVector(XMVector)

Converts a XMVector to a XMUDecN4.

Declaration

public static XMUDecN4 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUDecN4	A XMUDecN4.

| Edit this page View Source

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

| Edit this page View Source

ToPacked()

Converts a XMUDecN4 to a packed value.

Declaration

public uint ToPacked()

Returns

Type	Description
uint	A packed value.

| Edit this page View Source

ToVector()

Converts a XMUDecN4 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

| Edit this page View Source

operator ==(XMUDecN4, XMUDecN4)

Declaration

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

Parameters

Type	Name	Description
XMUDecN4	left
XMUDecN4	right

Returns

Type	Description
bool

| Edit this page View Source

implicit operator XMVector(XMUDecN4)

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

Parameters

Type	Name	Description
XMUDecN4	value	A XMUDecN4.

Returns

Type	Description
XMVector	A XMVector.

| Edit this page View Source

implicit operator uint(XMUDecN4)

Converts a XMUDecN4 to a packed value.

Declaration

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

Parameters

Type	Name	Description
XMUDecN4	value	A XMUDecN4.

Returns

Type	Description
uint	A packed value.

| Edit this page View Source

implicit operator XMUDecN4(XMVector)

Converts a XMVector to a XMUDecN4.

Declaration

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

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUDecN4	A XMUDecN4.

| Edit this page View Source

implicit operator XMUDecN4(uint)

Converts a packed value to a XMUDecN4.

Declaration

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

Parameters

Type	Name	Description
uint	value	A packed value.

Returns

Type	Description
XMUDecN4	A XMUDecN4.

| Edit this page View Source

operator !=(XMUDecN4, XMUDecN4)

Declaration

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

Parameters

Type	Name	Description
XMUDecN4	left
XMUDecN4	right

Returns

Type	Description
bool

Implements

IEquatable<T>