Struct Half4

Namespace

Stride.Core.Mathematics

Assembly

Stride.Core.Mathematics.dll

Represents a four dimensional mathematical vector with half-precision floats.

[DataContract]
public struct Half4 : IEquatable<Half4>

Implements

IEquatable<Half4>

Inherited Members

ValueType.ToString()

Constructors

Half4(Half)

Initializes a new instance of the Half4 structure.

public Half4(Half value)

Parameters

value Half

The value to set for the X, Y, Z, and W components.

Half4(Half, Half, Half, Half)

Initializes a new instance of the Half4 structure.

public Half4(Half x, Half y, Half z, Half w)

Parameters

x Half

The X component.

y Half

The Y component.

z Half

The Z component.

w Half

The W component.

Half4(Half[])

Initializes a new instance of the Half4 struct.

public Half4(Half[] values)

Parameters

values Half[]

The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements.

Exceptions

ArgumentNullException

Thrown when values is null.

ArgumentOutOfRangeException

Thrown when values contains more or less than four elements.

Half4(float)

Initializes a new instance of the Half4 structure.

public Half4(float value)

Parameters

value float

The value to set for the X, Y, Z, and W components.

Half4(float, float, float, float)

Initializes a new instance of the Half4 structure.

public Half4(float x, float y, float z, float w)

Parameters

x float

The X component.

y float

The Y component.

z float

The Z component.

w float

The W component.

Fields

One

A Half4 with all of its components set to one.

public static readonly Half4 One

Field Value

Half4

SizeInBytes

The size of the Half4 type, in bytes.

public static readonly int SizeInBytes

Field Value

int

UnitW

The W unit Half4 (0, 0, 0, 1).

public static readonly Half4 UnitW

Field Value

Half4

UnitX

The X unit Half4 (1, 0, 0, 0).

public static readonly Half4 UnitX

Field Value

Half4

UnitY

The Y unit Half4 (0, 1, 0, 0).

public static readonly Half4 UnitY

Field Value

Half4

UnitZ

The Z unit Half4 (0, 0, 1, 0).

public static readonly Half4 UnitZ

Field Value

Half4

W

Gets or sets the W component of the vector.

public Half W

Field Value

Half

The W component of the vector.

X

Gets or sets the X component of the vector.

public Half X

Field Value

Half

The X component of the vector.

Y

Gets or sets the Y component of the vector.

public Half Y

Field Value

Half

The Y component of the vector.

Z

Gets or sets the Z component of the vector.

public Half Z

Field Value

Half

The Z component of the vector.

Zero

A Half4 with all of its components set to zero.

public static readonly Half4 Zero

Field Value

Half4

Methods

Deconstruct(out Half, out Half, out Half, out Half)

Deconstructs the vector's components into named variables.

public void Deconstruct(out Half x, out Half y, out Half z, out Half w)

Parameters

x Half

The X component

y Half

The Y component

z Half

The Z component

w Half

The W component

Equals(Half4)

Returns a value that indicates whether the current instance is equal to the specified object.

public bool Equals(Half4 other)

Parameters

other Half4

Object to make the comparison with.

Returns

bool

true if the current instance is equal to the specified object; false otherwise.

Equals(ref readonly Half4, ref readonly Half4)

Determines whether the specified object instances are considered equal.

public static bool Equals(ref readonly Half4 value1, ref readonly Half4 value2)

Parameters

value1 Half4

The first value.

value2 Half4

The second value.

Returns

bool

true if value1 is the same instance as value2 or if both are null references or if value1.Equals(value2) returns true; otherwise, false.

Equals(object)

Returns a value that indicates whether the current instance is equal to a specified object.

public override bool Equals(object obj)

Parameters

obj object

Object to make the comparison with.

Returns

bool

true if the current instance is equal to the specified object; false otherwise.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer hash code.

Operators

operator ==(Half4, Half4)

Tests for equality between two objects.

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

Parameters

left Half4

The first value to compare.

right Half4

The second value to compare.

Returns

bool

true if left has the same value as right; otherwise, false.

explicit operator Vector4(Half4)

Performs an explicit conversion from Half4 to Vector4.

public static explicit operator Vector4(Half4 value)

Parameters

value Half4

The value.

Returns

Vector4

The result of the conversion.

explicit operator Half4(Vector4)

Performs an explicit conversion from Vector4 to Half4.

public static explicit operator Half4(Vector4 value)

Parameters

value Vector4

The value.

Returns

Half4

The result of the conversion.

operator !=(Half4, Half4)

Tests for inequality between two objects.

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

Parameters

left Half4

The first value to compare.

right Half4

The second value to compare.

Returns

bool

true if left has a different value than right; otherwise, false.