Struct XMShort2

A 2D vector consisting of 16-bit signed and normalized integer components.

Implements

IEquatable<XMShort2>

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

Constructors

XMShort2(short, short)

Initializes a new instance of the XMShort2 struct.

Declaration

public XMShort2(short x, short y)

Parameters

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

XMShort2(short[])

Initializes a new instance of the XMShort2 struct.

Declaration

public XMShort2(short[] array)

Parameters

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

XMShort2(float, float)

Initializes a new instance of the XMShort2 struct.

Declaration

public XMShort2(float x, float y)

Parameters

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

XMShort2(float[])

Initializes a new instance of the XMShort2 struct.

Declaration

public XMShort2(float[] array)

Parameters

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

XMShort2(uint)

Initializes a new instance of the XMShort2 struct.

Declaration

public XMShort2(uint packed)

Parameters

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

Properties

X

Gets or sets the x-coordinate of the vector.

Declaration

public short X { get; set; }

Property Value

Type	Description
short

Y

Gets or sets the y-coordinate of the vector.

Declaration

public short Y { get; set; }

Property Value

Type	Description
short

Methods

Equals(XMShort2)

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

Declaration

public bool Equals(XMShort2 other)

Parameters

Type	Name	Description
XMShort2	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)

FromVector(XMVector)

Converts a XMVector to a XMShort2.

Declaration

public static XMShort2 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMShort2	A XMShort2.

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()

ToVector()

Converts a XMShort2 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

operator ==(XMShort2, XMShort2)

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

Declaration

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

Parameters

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

Returns

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

implicit operator XMVector(XMShort2)

Converts a XMShort2 to a XMVector.

Declaration

public static implicit operator XMVector(XMShort2 value)

Parameters

Type	Name	Description
XMShort2	value	A XMShort2.

Returns

Type	Description
XMVector	A XMVector.

implicit operator XMShort2(XMVector)

Converts a XMVector to a XMShort2.

Declaration

public static implicit operator XMShort2(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMShort2	A XMShort2.

operator !=(XMShort2, XMShort2)

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

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>