Struct XMUByte4

A 4D vector where each component is a unsigned integer, 8-bits (1 byte) in length.

Implements

IEquatable<XMUByte4>

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

Constructors

| Edit this page View Source

XMUByte4(byte, byte, byte, byte)

Initializes a new instance of the XMUByte4 struct.

Declaration

public XMUByte4(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

XMUByte4(byte[])

Initializes a new instance of the XMUByte4 struct.

Declaration

public XMUByte4(byte[] array)

Parameters

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

| Edit this page View Source

XMUByte4(float, float, float, float)

Initializes a new instance of the XMUByte4 struct.

Declaration

public XMUByte4(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

XMUByte4(float[])

Initializes a new instance of the XMUByte4 struct.

Declaration

public XMUByte4(float[] array)

Parameters

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

| Edit this page View Source

XMUByte4(uint)

Initializes a new instance of the XMUByte4 struct.

Declaration

public XMUByte4(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

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

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

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

public byte Z { get; set; }

Property Value

Type	Description
byte

Methods

| Edit this page View Source

Equals(XMUByte4)

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

Declaration

public bool Equals(XMUByte4 other)

Parameters

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

| Edit this page View Source

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)

| Edit this page View Source

FromVector(XMVector)

Converts a XMVector to a XMUByte4.

Declaration

public static XMUByte4 FromVector(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUByte4	A XMUByte4.

| Edit this page View Source

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

| Edit this page View Source

ToVector()

Converts a XMUByte4 to a XMVector.

Declaration

public XMVector ToVector()

Returns

Type	Description
XMVector	A XMVector.

Operators

| Edit this page View Source

operator ==(XMUByte4, XMUByte4)

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

Declaration

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

Parameters

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

Returns

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

| Edit this page View Source

implicit operator XMVector(XMUByte4)

Converts a XMUByte4 to a XMVector.

Declaration

public static implicit operator XMVector(XMUByte4 value)

Parameters

Type	Name	Description
XMUByte4	value	A XMUByte4.

Returns

Type	Description
XMVector	A XMVector.

| Edit this page View Source

implicit operator XMUByte4(XMVector)

Converts a XMVector to a XMUByte4.

Declaration

public static implicit operator XMUByte4(XMVector value)

Parameters

Type	Name	Description
XMVector	value	A XMVector.

Returns

Type	Description
XMUByte4	A XMUByte4.

| Edit this page View Source

operator !=(XMUByte4, XMUByte4)

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

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>