Struct XMByteN2

A 2D vector for storing signed, normalized values as signed 8-bits (1 byte) integers.

Implements

IEquatable<XMByteN2>

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

Constructors

| Edit this page View Source

XMByteN2(ReadOnlySpan<sbyte>)

Initializes a new instance of the XMByteN2 struct.

Declaration

public XMByteN2(ReadOnlySpan<sbyte> array)

Parameters

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

| Edit this page View Source

XMByteN2(ReadOnlySpan<float>)

Initializes a new instance of the XMByteN2 struct.

Declaration

public XMByteN2(ReadOnlySpan<float> array)

Parameters

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

| Edit this page View Source

XMByteN2(sbyte, sbyte)

Initializes a new instance of the XMByteN2 struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "x", Justification = "Reviewed")]
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "y", Justification = "Reviewed")]
public XMByteN2(sbyte x, sbyte y)

Parameters

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

| Edit this page View Source

XMByteN2(sbyte[])

Initializes a new instance of the XMByteN2 struct.

Declaration

public XMByteN2(sbyte[] array)

Parameters

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

| Edit this page View Source

XMByteN2(float, float)

Initializes a new instance of the XMByteN2 struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "x", Justification = "Reviewed")]
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "y", Justification = "Reviewed")]
public XMByteN2(float x, float y)

Parameters

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

| Edit this page View Source

XMByteN2(float[])

Initializes a new instance of the XMByteN2 struct.

Declaration

public XMByteN2(float[] array)

Parameters

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

| Edit this page View Source

XMByteN2(ushort)

Initializes a new instance of the XMByteN2 struct.

Declaration

public XMByteN2(ushort packed)

Parameters

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

Properties

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

Property Value

Type	Description
sbyte

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

Property Value

Type	Description
sbyte

Methods

| Edit this page View Source

Equals(XMByteN2)

Declaration

public readonly bool Equals(XMByteN2 other)

Parameters

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

FromVector(XMVector)

Converts a XMVector to a XMByteN2.

Declaration

public static XMByteN2 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMByteN2	A XMByteN2.

| Edit this page View Source

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

| Edit this page View Source

ToVector()

Converts a XMByteN2 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

| Edit this page View Source

operator ==(XMByteN2, XMByteN2)

Declaration

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

Parameters

Type	Name	Description
XMByteN2	left
XMByteN2	right

Returns

Type	Description
bool

| Edit this page View Source

implicit operator XMVector(XMByteN2)

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

Parameters

Type	Name	Description
XMByteN2	value	A XMByteN2.

Returns

Type	Description
XMVector	A XMVector.

| Edit this page View Source

implicit operator XMByteN2(XMVector)

Converts a XMVector to a XMByteN2.

Declaration

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

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMByteN2	A XMByteN2.

| Edit this page View Source

operator !=(XMByteN2, XMByteN2)

Declaration

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

Parameters

Type	Name	Description
XMByteN2	left
XMByteN2	right

Returns

Type	Description
bool

Implements

IEquatable<T>