Struct Half2
- Namespace
- Stride.Core.Mathematics
- Assembly
- Stride.Core.Mathematics.dll
Represents a two dimensional mathematical vector with half-precision floats.
[DataContract]
public struct Half2 : IEquatable<Half2>
- Implements
- Inherited Members
Constructors
Half2(Half)
Initializes a new instance of the Half2 structure.
public Half2(Half value)
Parameters
value
HalfThe value to set for both the X and Y components.
Half2(Half, Half)
Initializes a new instance of the Half2 structure.
public Half2(Half x, Half y)
Parameters
Half2(Half[])
Initializes a new instance of the Half2 struct.
public Half2(Half[] values)
Parameters
values
Half[]The values to assign to the X and Y components of the vector. This must be an array with two elements.
Exceptions
- ArgumentNullException
Thrown when
values
isnull
.- ArgumentOutOfRangeException
Thrown when
values
contains more or less than two elements.
Half2(float)
Initializes a new instance of the Half2 structure.
public Half2(float value)
Parameters
value
floatThe value to set for both the X and Y components.
Half2(float, float)
Initializes a new instance of the Half2 structure.
public Half2(float x, float y)
Parameters
Fields
One
A Half2 with all of its components set to one.
public static readonly Half2 One
Field Value
SizeInBytes
The size of the Half2 type, in bytes.
public static readonly int SizeInBytes
Field Value
UnitX
The X unit Half2 (1, 0).
public static readonly Half2 UnitX
Field Value
UnitY
The Y unit Half2 (0, 1).
public static readonly Half2 UnitY
Field Value
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.
Zero
A Half2 with all of its components set to zero.
public static readonly Half2 Zero
Field Value
Methods
Deconstruct(out Half, out Half)
Deconstructs the vector's components into named variables.
public void Deconstruct(out Half x, out Half y)
Parameters
Equals(Half2)
Returns a value that indicates whether the current instance is equal to the specified object.
public bool Equals(Half2 other)
Parameters
other
Half2Object to make the comparison with.
Returns
- bool
true
if the current instance is equal to the specified object;false
otherwise.
Equals(ref readonly Half2, ref readonly Half2)
Determines whether the specified object instances are considered equal.
public static bool Equals(ref readonly Half2 value1, ref readonly Half2 value2)
Parameters
Returns
- bool
true
ifvalue1
is the same instance asvalue2
or if both arenull
references or ifvalue1.Equals(value2)
returnstrue
; 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
objectObject 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 ==(Half2, Half2)
Tests for equality between two objects.
public static bool operator ==(Half2 left, Half2 right)
Parameters
Returns
- bool
true
ifleft
has the same value asright
; otherwise,false
.
explicit operator Vector2(Half2)
public static explicit operator Vector2(Half2 value)
Parameters
value
Half2The value.
Returns
- Vector2
The result of the conversion.
explicit operator Half2(Vector2)
public static explicit operator Half2(Vector2 value)
Parameters
value
Vector2The value.
Returns
- Half2
The result of the conversion.
operator !=(Half2, Half2)
Tests for inequality between two objects.
public static bool operator !=(Half2 left, Half2 right)
Parameters
Returns
- bool
true
ifleft
has a different value thanright
; otherwise,false
.