Struct XMUDec4

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

Implements

IEquatable<XMUDec4>

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

public struct XMUDec4 : IEquatable<XMUDec4>

Constructors

XMUDec4(float, float, float, float)

Initializes a new instance of the XMUDec4 struct.

Declaration

public XMUDec4(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.

XMUDec4(float[])

Initializes a new instance of the XMUDec4 struct.

Declaration

public XMUDec4(float[] array)

Parameters

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

XMUDec4(uint)

Initializes a new instance of the XMUDec4 struct.

Declaration

public XMUDec4(uint packed)

Parameters

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

Properties

W

Gets or sets the w-coordinate of the vector.

Declaration

public uint W { get; set; }

Property Value

Type	Description
uint

X

Gets or sets the x-coordinate of the vector.

Declaration

public uint X { get; set; }

Property Value

Type	Description
uint

Y

Gets or sets the y-coordinate of the vector.

Declaration

public uint Y { get; set; }

Property Value

Type	Description
uint

Z

Gets or sets the z-coordinate of the vector.

Declaration

public uint Z { get; set; }

Property Value

Type	Description
uint

Methods

Equals(XMUDec4)

Determines whether the specified object is equal to the current object.

Declaration

public bool Equals(XMUDec4 other)

Parameters

Type	Name	Description
XMUDec4	other	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueType.Equals(object)

FromPacked(uint)

Converts a packed value to a XMUDec4.

Declaration

public static XMUDec4 FromPacked(uint value)

Parameters

Type	Name	Description
uint	value	A packed value.

Returns

Type	Description
XMUDec4	A XMUDec4.

FromVector(XMVector)

Converts a XMVector to a XMUDec4.

Declaration

public static XMUDec4 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUDec4	A XMUDec4.

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

ToPacked()

Converts a XMUDec4 to a packed value.

Declaration

public uint ToPacked()

Returns

Type	Description
uint	A packed value.

ToVector()

Converts a XMUDec4 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

operator ==(XMUDec4, XMUDec4)

Compares two XMUDec4 objects. The result specifies whether the values of the two objects are equal.

Declaration

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

Parameters

Type	Name	Description
XMUDec4	left	The left XMUDec4 to compare.
XMUDec4	right	The right XMUDec4 to compare.

Returns

Type	Description
bool	true if the values of left and right are equal; otherwise, false.

implicit operator XMVector(XMUDec4)

Converts a XMUDec4 to a XMVector.

Declaration

public static implicit operator XMVector(XMUDec4 value)

Parameters

Type	Name	Description
XMUDec4	value	A XMUDec4.

Returns

Type	Description
XMVector	A XMVector.

implicit operator uint(XMUDec4)

Converts a XMUDec4 to a packed value.

Declaration

public static implicit operator uint(XMUDec4 value)

Parameters

Type	Name	Description
XMUDec4	value	A XMUDec4.

Returns

Type	Description
uint	A packed value.

implicit operator XMUDec4(XMVector)

Converts a XMVector to a XMUDec4.

Declaration

public static implicit operator XMUDec4(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUDec4	A XMUDec4.

implicit operator XMUDec4(uint)

Converts a packed value to a XMUDec4.

Declaration

public static implicit operator XMUDec4(uint value)

Parameters

Type	Name	Description
uint	value	A packed value.

Returns

Type	Description
XMUDec4	A XMUDec4.

operator !=(XMUDec4, XMUDec4)

Compares two XMUDec4 objects. The result specifies whether the values of the two objects are unequal.

Declaration

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

Parameters

Type	Name	Description
XMUDec4	left	The left XMUDec4 to compare.
XMUDec4	right	The right XMUDec4 to compare.

Returns

Type	Description
bool	true if the values of left and right differ; otherwise, false.

Implements

IEquatable<T>