Struct Half3

Namespace

Stride.Core.Mathematics

Assembly

Stride.Core.Mathematics.dll

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

[DataContract]
public struct Half3 : IEquatable<Half3>

Implements

IEquatable<Half3>

Constructors

Half3(Half)

Initializes a new instance of the Half3 structure.

public Half3(Half value)

Parameters

value Half

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

Half3(Half, Half, Half)

Initializes a new instance of the Half3 structure.

public Half3(Half x, Half y, Half z)

Parameters

x Half

The X component.

y Half

The Y component.

z Half

The Z component.

Half3(Half[])

Initializes a new instance of the Half3 struct.

public Half3(Half[] values)

Parameters

values Half[]

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

Exceptions

ArgumentNullException

Thrown when values is null.

ArgumentOutOfRangeException

Thrown when values contains more or less than three elements.

Half3(float)

Initializes a new instance of the Half3 structure.

public Half3(float value)

Parameters

value float

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

Half3(float, float, float)

Initializes a new instance of the Half3 structure.

public Half3(float x, float y, float z)

Parameters

x float

The X component.

y float

The Y component.

z float

The Z component.

Fields

One

A Half3 with all of its components set to one.

public static readonly Half3 One

Field Value

Half3

SizeInBytes

The size of the Half3 type, in bytes.

public static readonly int SizeInBytes

Field Value

int

UnitX

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

public static readonly Half3 UnitX

Field Value

Half3

UnitY

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

public static readonly Half3 UnitY

Field Value

Half3

UnitZ

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

public static readonly Half3 UnitZ

Field Value

Half3

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 Half3 with all of its components set to zero.

public static readonly Half3 Zero

Field Value

Half3

Methods

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

Parameters

x Half

The X component

y Half

The Y component

z Half

The Z component

Equals(Half3)

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

public bool Equals(Half3 other)

Parameters

other Half3

Object to make the comparison with.

Returns

bool

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

Equals(ref readonly Half3, ref readonly Half3)

Determines whether the specified object instances are considered equal.

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

Parameters

value1 Half3

The first value.

value2 Half3

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.

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns

string

A string that represents this instance.

Operators

operator ==(Half3, Half3)

Tests for equality between two objects.

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

Parameters

left Half3

The first value to compare.

right Half3

The second value to compare.

Returns

bool

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

explicit operator Vector3(Half3)

Performs an explicit conversion from Half3 to Vector3.

public static explicit operator Vector3(Half3 value)

Parameters

value Half3

The value.

Returns

Vector3

The result of the conversion.

explicit operator Half3(Vector3)

Performs an explicit conversion from Vector3 to Half3.

public static explicit operator Half3(Vector3 value)

Parameters

value Vector3

The value.

Returns

Half3

The result of the conversion.

operator !=(Half3, Half3)

Tests for inequality between two objects.

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

Parameters

left Half3

The first value to compare.

right Half3

The second value to compare.

Returns

bool

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