Struct XMU555

A 4D vector with x-,y-, and z- components represented as 5 bit unsigned integer values, and the w-component as a 1 bit integer value.

Implements

IEquatable<XMU555>

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

Constructors

| Edit this page View Source

XMU555(byte, byte, byte, bool)

Initializes a new instance of the XMU555 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 XMU555(byte x, byte y, byte z, bool w)

Parameters

Type	Name	Description
byte	x	The x-coordinate of the vector.
byte	y	The y-coordinate of the vector.
byte	z	The z-coordinate of the vector.
bool	w	The w-coordinate of the vector.

| Edit this page View Source

XMU555(byte[], bool)

Initializes a new instance of the XMU555 struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "w", Justification = "Reviewed")]
public XMU555(byte[] array, bool w)

Parameters

Type	Name	Description
byte[]	array	The x y z components of the vector.
bool	w	The w component of the vector.

| Edit this page View Source

XMU555(ReadOnlySpan<byte>, bool)

Initializes a new instance of the XMU555 struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "w", Justification = "Reviewed")]
public XMU555(ReadOnlySpan<byte> array, bool w)

Parameters

Type	Name	Description
ReadOnlySpan<byte>	array	The x y z components of the vector.
bool	w	The w component of the vector.

| Edit this page View Source

XMU555(ReadOnlySpan<float>, bool)

Initializes a new instance of the XMU555 struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "w", Justification = "Reviewed")]
public XMU555(ReadOnlySpan<float> array, bool w)

Parameters

Type	Name	Description
ReadOnlySpan<float>	array	The x y z components of the vector.
bool	w	The w component of the vector.

| Edit this page View Source

XMU555(float, float, float, bool)

Initializes a new instance of the XMU555 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 XMU555(float x, float y, float z, bool 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.
bool	w	The w-coordinate of the vector.

| Edit this page View Source

XMU555(float[], bool)

Initializes a new instance of the XMU555 struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "w", Justification = "Reviewed")]
public XMU555(float[] array, bool w)

Parameters

Type	Name	Description
float[]	array	The x y z components of the vector.
bool	w	The w component of the vector.

| Edit this page View Source

XMU555(ushort)

Initializes a new instance of the XMU555 struct.

Declaration

public XMU555(ushort packed)

Parameters

Type	Name	Description
ushort	packed	A packed value representing the vector.

Properties

| Edit this page View Source

W

Gets or sets a value indicating whether the w-coordinate of the vector is set.

Declaration

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

Property Value

Type	Description
bool

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

Property Value

Type	Description
byte

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

Property Value

Type	Description
byte

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

Property Value

Type	Description
byte

Methods

| Edit this page View Source

Equals(XMU555)

Declaration

public readonly bool Equals(XMU555 other)

Parameters

Type	Name	Description
XMU555	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(ushort)

Converts a packed value to a XMU555.

Declaration

public static XMU555 FromPacked(ushort value)

Parameters

Type	Name	Description
ushort	value	A packed value.

Returns

Type	Description
XMU555	A XMU555.

| Edit this page View Source

FromVector(XMVector)

Converts a XMVector to a XMU555.

Declaration

public static XMU555 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMU555	A XMU555.

| 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 XMU555 to a packed value.

Declaration

public ushort ToPacked()

Returns

Type	Description
ushort	A packed value.

| Edit this page View Source

ToVector()

Converts a XMU555 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

| Edit this page View Source

operator ==(XMU555, XMU555)

Declaration

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

Parameters

Type	Name	Description
XMU555	left
XMU555	right

Returns

Type	Description
bool

| Edit this page View Source

implicit operator XMVector(XMU555)

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

Parameters

Type	Name	Description
XMU555	value	A XMU555.

Returns

Type	Description
XMVector	A XMVector.

| Edit this page View Source

implicit operator ushort(XMU555)

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

Parameters

Type	Name	Description
XMU555	value	A XMU555.

Returns

Type	Description
ushort	A packed value.

| Edit this page View Source

implicit operator XMU555(XMVector)

Converts a XMVector to a XMU555.

Declaration

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

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMU555	A XMU555.

| Edit this page View Source

implicit operator XMU555(ushort)

Converts a packed value to a XMU555.

Declaration

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

Parameters

Type	Name	Description
ushort	value	A packed value.

Returns

Type	Description
XMU555	A XMU555.

| Edit this page View Source

operator !=(XMU555, XMU555)

Declaration

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

Parameters

Type	Name	Description
XMU555	left
XMU555	right

Returns

Type	Description
bool

Implements

IEquatable<T>