Struct XMUDecN4XR
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
Inherited Members
Namespace: JeremyAnsel.DirectX.DXMath.PackedVector
Assembly: JeremyAnsel.DirectX.DXMath.dll
Syntax
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "XMU", Justification = "Reviewed")]
public struct XMUDecN4XR : IEquatable<XMUDecN4XR>
Constructors
| Edit this page View SourceXMUDecN4XR(ReadOnlySpan<float>)
Initializes a new instance of the XMUDecN4XR struct.
Declaration
public XMUDecN4XR(ReadOnlySpan<float> array)
Parameters
| Type | Name | Description |
|---|---|---|
| ReadOnlySpan<float> | array | The components of the vector. |
XMUDecN4XR(float, float, float, float)
Initializes a new instance of the XMUDecN4XR 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 XMUDecN4XR(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. |
XMUDecN4XR(float[])
Initializes a new instance of the XMUDecN4XR struct.
Declaration
public XMUDecN4XR(float[] array)
Parameters
| Type | Name | Description |
|---|---|---|
| float[] | array | The components of the vector. |
XMUDecN4XR(uint)
Initializes a new instance of the XMUDecN4XR struct.
Declaration
public XMUDecN4XR(uint packed)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | packed | A packed value representing the vector. |
Properties
| Edit this page View SourceW
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 |
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
| Edit this page View SourceEquals(XMUDecN4XR)
Declaration
public readonly bool Equals(XMUDecN4XR other)
Parameters
| Type | Name | Description |
|---|---|---|
| XMUDecN4XR | 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
| Edit this page View SourceFromPacked(uint)
Converts a packed value to a XMUDecN4XR.
Declaration
public static XMUDecN4XR FromPacked(uint value)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | value | A packed value. |
Returns
| Type | Description |
|---|---|
| XMUDecN4XR | A XMUDecN4XR. |
FromVector(XMVector)
Converts a XMVector to a XMUDecN4XR.
Declaration
public static XMUDecN4XR FromVector(XMVector value)
Parameters
| Type | Name | Description |
|---|---|---|
| XMVector | value | A XMVector. |
Returns
| Type | Description |
|---|---|
| XMUDecN4XR | A XMUDecN4XR. |
GetHashCode()
Declaration
public override readonly int GetHashCode()
Returns
| Type | Description |
|---|---|
| int |
Overrides
| Edit this page View SourceToPacked()
Converts a XMUDecN4XR to a packed value.
Declaration
public uint ToPacked()
Returns
| Type | Description |
|---|---|
| uint | A packed value. |
ToVector()
Converts a XMUDecN4XR to a XMVector.
Declaration
public XMVector ToVector()
Returns
| Type | Description |
|---|---|
| XMVector | A XMVector. |
Operators
| Edit this page View Sourceoperator ==(XMUDecN4XR, XMUDecN4XR)
Declaration
public static bool operator ==(XMUDecN4XR left, XMUDecN4XR right)
Parameters
| Type | Name | Description |
|---|---|---|
| XMUDecN4XR | left | |
| XMUDecN4XR | right |
Returns
| Type | Description |
|---|---|
| bool |
implicit operator XMVector(XMUDecN4XR)
Converts a XMUDecN4XR 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(XMUDecN4XR value)
Parameters
| Type | Name | Description |
|---|---|---|
| XMUDecN4XR | value | A XMUDecN4XR. |
Returns
| Type | Description |
|---|---|
| XMVector | A XMVector. |
implicit operator uint(XMUDecN4XR)
Converts a XMUDecN4XR 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(XMUDecN4XR value)
Parameters
| Type | Name | Description |
|---|---|---|
| XMUDecN4XR | value | A XMUDecN4XR. |
Returns
| Type | Description |
|---|---|
| uint | A packed value. |
implicit operator XMUDecN4XR(XMVector)
Converts a XMVector to a XMUDecN4XR.
Declaration
[SuppressMessage("Usage", "CA2225:Les surcharges d'opérateur offrent d'autres méthodes nommées", Justification = "Reviewed.")]
public static implicit operator XMUDecN4XR(XMVector value)
Parameters
| Type | Name | Description |
|---|---|---|
| XMVector | value | A XMVector. |
Returns
| Type | Description |
|---|---|
| XMUDecN4XR | A XMUDecN4XR. |
implicit operator XMUDecN4XR(uint)
Converts a packed value to a XMUDecN4XR.
Declaration
[SuppressMessage("Usage", "CA2225:Les surcharges d'opérateur offrent d'autres méthodes nommées", Justification = "Reviewed.")]
public static implicit operator XMUDecN4XR(uint value)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | value | A packed value. |
Returns
| Type | Description |
|---|---|
| XMUDecN4XR | A XMUDecN4XR. |
operator !=(XMUDecN4XR, XMUDecN4XR)
Declaration
public static bool operator !=(XMUDecN4XR left, XMUDecN4XR right)
Parameters
| Type | Name | Description |
|---|---|---|
| XMUDecN4XR | left | |
| XMUDecN4XR | right |
Returns
| Type | Description |
|---|---|
| bool |