Struct XMUByteN4

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

Implements

IEquatable<XMUByteN4>

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

Constructors

| Edit this page View Source

XMUByteN4(byte, byte, byte, byte)

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

| Edit this page View Source

XMUByteN4(byte[])

Initializes a new instance of the XMUByteN4 struct.

Declaration

public XMUByteN4(byte[] array)

Parameters

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

| Edit this page View Source

XMUByteN4(ReadOnlySpan<byte>)

Initializes a new instance of the XMUByteN4 struct.

Declaration

public XMUByteN4(ReadOnlySpan<byte> array)

Parameters

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

| Edit this page View Source

XMUByteN4(ReadOnlySpan<float>)

Initializes a new instance of the XMUByteN4 struct.

Declaration

public XMUByteN4(ReadOnlySpan<float> array)

Parameters

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

| Edit this page View Source

XMUByteN4(float, float, float, float)

Initializes a new instance of the XMUByteN4 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 XMUByteN4(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.

| Edit this page View Source

XMUByteN4(float[])

Initializes a new instance of the XMUByteN4 struct.

Declaration

public XMUByteN4(float[] array)

Parameters

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

| Edit this page View Source

XMUByteN4(uint)

Initializes a new instance of the XMUByteN4 struct.

Declaration

public XMUByteN4(uint packed)

Parameters

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

Properties

| Edit this page View Source

W

Gets or sets the w-coordinate of the vector.

Declaration

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

Property Value

Type	Description
byte

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

Declaration

public readonly bool Equals(XMUByteN4 other)

Parameters

Type	Name	Description
XMUByteN4	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 XMUByteN4.

Declaration

public static XMUByteN4 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUByteN4	A XMUByteN4.

| 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 XMUByteN4 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

| Edit this page View Source

operator ==(XMUByteN4, XMUByteN4)

Declaration

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

Parameters

Type	Name	Description
XMUByteN4	left
XMUByteN4	right

Returns

Type	Description
bool

| Edit this page View Source

implicit operator XMVector(XMUByteN4)

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

Parameters

Type	Name	Description
XMUByteN4	value	A XMUByteN4.

Returns

Type	Description
XMVector	A XMVector.

| Edit this page View Source

implicit operator XMUByteN4(XMVector)

Converts a XMVector to a XMUByteN4.

Declaration

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

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUByteN4	A XMUByteN4.

| Edit this page View Source

operator !=(XMUByteN4, XMUByteN4)

Declaration

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

Parameters

Type	Name	Description
XMUByteN4	left
XMUByteN4	right

Returns

Type	Description
bool

Implements

IEquatable<T>