Struct Vector2
Represents a 2D vector using two single-precision floating-point numbers.
Inherited Members
Namespace: OpenTK.Mathematics
Assembly: OpenTK.Mathematics.dll
Syntax
[Serializable]
public struct Vector2 : IEquatable<Vector2>, IFormattable
Remarks
The Vector2 structure is suitable for interoperation with unmanaged code requiring two consecutive floats.
Constructors
Vector2(float, float)
Initializes a new instance of the Vector2 struct.
Declaration
public Vector2(float x, float y)
Parameters
Type | Name | Description |
---|---|---|
float | x | The x coordinate of the net Vector2. |
float | y | The y coordinate of the net Vector2. |
Vector2(float)
Initializes a new instance of the Vector2 struct.
Declaration
public Vector2(float value)
Parameters
Type | Name | Description |
---|---|---|
float | value | The value that will initialize this instance. |
Fields
NegativeInfinity
Defines an instance with all components set to negative infinity.
Declaration
public static readonly Vector2 NegativeInfinity
Field Value
Type | Description |
---|---|
Vector2 |
One
Defines an instance with all components set to 1.
Declaration
public static readonly Vector2 One
Field Value
Type | Description |
---|---|
Vector2 |
PositiveInfinity
Defines an instance with all components set to positive infinity.
Declaration
public static readonly Vector2 PositiveInfinity
Field Value
Type | Description |
---|---|
Vector2 |
SizeInBytes
Defines the size of the Vector2 struct in bytes.
Declaration
public static readonly int SizeInBytes
Field Value
Type | Description |
---|---|
int |
UnitX
Defines a unit-length Vector2 that points towards the X-axis.
Declaration
public static readonly Vector2 UnitX
Field Value
Type | Description |
---|---|
Vector2 |
UnitY
Defines a unit-length Vector2 that points towards the Y-axis.
Declaration
public static readonly Vector2 UnitY
Field Value
Type | Description |
---|---|
Vector2 |
X
The X component of the Vector2.
Declaration
public float X
Field Value
Type | Description |
---|---|
float |
Y
The Y component of the Vector2.
Declaration
public float Y
Field Value
Type | Description |
---|---|
float |
Zero
Defines an instance with all components set to 0.
Declaration
public static readonly Vector2 Zero
Field Value
Type | Description |
---|---|
Vector2 |
Properties
this[int]
Gets or sets the value at the index of the Vector.
Declaration
public float this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
int | index | The index of the component from the Vector. |
Property Value
Type | Description |
---|---|
float |
Exceptions
Type | Condition |
---|---|
IndexOutOfRangeException | Thrown if the index is less than 0 or greater than 1. |
Length
Gets the length (magnitude) of the vector.
Declaration
public float Length { get; }
Property Value
Type | Description |
---|---|
float |
See Also
LengthFast
Gets an approximation of the vector length (magnitude).
Declaration
public float LengthFast { get; }
Property Value
Type | Description |
---|---|
float |
Remarks
This property uses an approximation of the square root function to calculate vector magnitude, with an upper error bound of 0.001.
See Also
LengthSquared
Gets the square of the vector length (magnitude).
Declaration
public float LengthSquared { get; }
Property Value
Type | Description |
---|---|
float |
Remarks
This property avoids the costly square root operation required by the Length property. This makes it more suitable for comparisons.
See Also
PerpendicularLeft
Gets the perpendicular vector on the left side of this vector.
Declaration
public Vector2 PerpendicularLeft { get; }
Property Value
Type | Description |
---|---|
Vector2 |
PerpendicularRight
Gets the perpendicular vector on the right side of this vector.
Declaration
public Vector2 PerpendicularRight { get; }
Property Value
Type | Description |
---|---|
Vector2 |
Yx
Gets or sets an OpenTK.Vector2 with the Y and X components of this instance.
Declaration
public Vector2 Yx { get; set; }
Property Value
Type | Description |
---|---|
Vector2 |
Methods
Add(Vector2, Vector2)
Adds two vectors.
Declaration
[Pure]
public static Vector2 Add(Vector2 a, Vector2 b)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | Left operand. |
Vector2 | b | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of operation. |
Add(in Vector2, in Vector2, out Vector2)
Adds two vectors.
Declaration
public static void Add(in Vector2 a, in Vector2 b, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | Left operand. |
Vector2 | b | Right operand. |
Vector2 | result | Result of operation. |
BaryCentric(Vector2, Vector2, Vector2, float, float)
Interpolate 3 Vectors using Barycentric coordinates.
Declaration
[Pure]
public static Vector2 BaryCentric(Vector2 a, Vector2 b, Vector2 c, float u, float v)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First input Vector. |
Vector2 | b | Second input Vector. |
Vector2 | c | Third input Vector. |
float | u | First Barycentric Coordinate. |
float | v | Second Barycentric Coordinate. |
Returns
Type | Description |
---|---|
Vector2 | a when u=v=0, b when u=1,v=0, c when u=0,v=1, and a linear combination of a,b,c otherwise. |
BaryCentric(in Vector2, in Vector2, in Vector2, float, float, out Vector2)
Interpolate 3 Vectors using Barycentric coordinates.
Declaration
public static void BaryCentric(in Vector2 a, in Vector2 b, in Vector2 c, float u, float v, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First input Vector. |
Vector2 | b | Second input Vector. |
Vector2 | c | Third input Vector. |
float | u | First Barycentric Coordinate. |
float | v | Second Barycentric Coordinate. |
Vector2 | result | Output Vector. a when u=v=0, b when u=1,v=0, c when u=0,v=1, and a linear combination of a,b,c otherwise. |
Clamp(Vector2, Vector2, Vector2)
Clamp a vector to the given minimum and maximum vectors.
Declaration
[Pure]
public static Vector2 Clamp(Vector2 vec, Vector2 min, Vector2 max)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | Input vector. |
Vector2 | min | Minimum vector. |
Vector2 | max | Maximum vector. |
Returns
Type | Description |
---|---|
Vector2 | The clamped vector. |
Clamp(in Vector2, in Vector2, in Vector2, out Vector2)
Clamp a vector to the given minimum and maximum vectors.
Declaration
public static void Clamp(in Vector2 vec, in Vector2 min, in Vector2 max, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | Input vector. |
Vector2 | min | Minimum vector. |
Vector2 | max | Maximum vector. |
Vector2 | result | The clamped vector. |
ComponentMax(Vector2, Vector2)
Returns a vector created from the largest of the corresponding components of the given vectors.
Declaration
[Pure]
public static Vector2 ComponentMax(Vector2 a, Vector2 b)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First operand. |
Vector2 | b | Second operand. |
Returns
Type | Description |
---|---|
Vector2 | The component-wise maximum. |
ComponentMax(in Vector2, in Vector2, out Vector2)
Returns a vector created from the largest of the corresponding components of the given vectors.
Declaration
public static void ComponentMax(in Vector2 a, in Vector2 b, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First operand. |
Vector2 | b | Second operand. |
Vector2 | result | The component-wise maximum. |
ComponentMin(Vector2, Vector2)
Returns a vector created from the smallest of the corresponding components of the given vectors.
Declaration
[Pure]
public static Vector2 ComponentMin(Vector2 a, Vector2 b)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First operand. |
Vector2 | b | Second operand. |
Returns
Type | Description |
---|---|
Vector2 | The component-wise minimum. |
ComponentMin(in Vector2, in Vector2, out Vector2)
Returns a vector created from the smallest of the corresponding components of the given vectors.
Declaration
public static void ComponentMin(in Vector2 a, in Vector2 b, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First operand. |
Vector2 | b | Second operand. |
Vector2 | result | The component-wise minimum. |
Deconstruct(out float, out float)
Deconstructs the vector into it's individual components.
Declaration
[Pure]
public void Deconstruct(out float x, out float y)
Parameters
Type | Name | Description |
---|---|---|
float | x | The X component of the vector. |
float | y | The Y component of the vector. |
Distance(Vector2, Vector2)
Compute the euclidean distance between two vectors.
Declaration
[Pure]
public static float Distance(Vector2 vec1, Vector2 vec2)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec1 | The first vector. |
Vector2 | vec2 | The second vector. |
Returns
Type | Description |
---|---|
float | The distance. |
Distance(in Vector2, in Vector2, out float)
Compute the euclidean distance between two vectors.
Declaration
public static void Distance(in Vector2 vec1, in Vector2 vec2, out float result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec1 | The first vector. |
Vector2 | vec2 | The second vector. |
float | result | The distance. |
DistanceSquared(Vector2, Vector2)
Compute the squared euclidean distance between two vectors.
Declaration
[Pure]
public static float DistanceSquared(Vector2 vec1, Vector2 vec2)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec1 | The first vector. |
Vector2 | vec2 | The second vector. |
Returns
Type | Description |
---|---|
float | The squared distance. |
DistanceSquared(in Vector2, in Vector2, out float)
Compute the squared euclidean distance between two vectors.
Declaration
public static void DistanceSquared(in Vector2 vec1, in Vector2 vec2, out float result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec1 | The first vector. |
Vector2 | vec2 | The second vector. |
float | result | The squared distance. |
Divide(Vector2, Vector2)
Divides a vector by the components of a vector (scale).
Declaration
[Pure]
public static Vector2 Divide(Vector2 vector, Vector2 scale)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vector | Left operand. |
Vector2 | scale | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of the operation. |
Divide(Vector2, float)
Divides a vector by a scalar.
Declaration
[Pure]
public static Vector2 Divide(Vector2 vector, float scale)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vector | Left operand. |
float | scale | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of the operation. |
Divide(in Vector2, in Vector2, out Vector2)
Divide a vector by the components of a vector (scale).
Declaration
public static void Divide(in Vector2 vector, in Vector2 scale, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vector | Left operand. |
Vector2 | scale | Right operand. |
Vector2 | result | Result of the operation. |
Divide(in Vector2, float, out Vector2)
Divides a vector by a scalar.
Declaration
public static void Divide(in Vector2 vector, float scale, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vector | Left operand. |
float | scale | Right operand. |
Vector2 | result | Result of the operation. |
Dot(Vector2, Vector2)
Calculate the dot (scalar) product of two vectors.
Declaration
[Pure]
public static float Dot(Vector2 left, Vector2 right)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | First operand. |
Vector2 | right | Second operand. |
Returns
Type | Description |
---|---|
float | The dot product of the two inputs. |
Dot(in Vector2, in Vector2, out float)
Calculate the dot (scalar) product of two vectors.
Declaration
public static void Dot(in Vector2 left, in Vector2 right, out float result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | First operand. |
Vector2 | right | Second operand. |
float | result | The dot product of the two inputs. |
Equals(Vector2)
Declaration
public bool Equals(Vector2 other)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | other |
Returns
Type | Description |
---|---|
bool |
Equals(object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj |
Returns
Type | Description |
---|---|
bool |
Overrides
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int |
Overrides
Lerp(Vector2, Vector2, Vector2)
Returns a new vector that is the component-wise linear blend of the 2 given vectors.
Declaration
[Pure]
public static Vector2 Lerp(Vector2 a, Vector2 b, Vector2 blend)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First input vector. |
Vector2 | b | Second input vector. |
Vector2 | blend | The blend factor. |
Returns
Type | Description |
---|---|
Vector2 | a when blend=0, b when blend=1, and a component-wise linear combination otherwise. |
Lerp(Vector2, Vector2, float)
Returns a new vector that is the linear blend of the 2 given vectors.
Declaration
[Pure]
public static Vector2 Lerp(Vector2 a, Vector2 b, float blend)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First input vector. |
Vector2 | b | Second input vector. |
float | blend | The blend factor. |
Returns
Type | Description |
---|---|
Vector2 | a when blend=0, b when blend=1, and a linear combination otherwise. |
Lerp(in Vector2, in Vector2, Vector2, out Vector2)
Returns a new vector that is the component-wise linear blend of the 2 given vectors.
Declaration
public static void Lerp(in Vector2 a, in Vector2 b, Vector2 blend, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First input vector. |
Vector2 | b | Second input vector. |
Vector2 | blend | The blend factor. |
Vector2 | result | a when blend=0, b when blend=1, and a component-wise linear combination otherwise. |
Lerp(in Vector2, in Vector2, float, out Vector2)
Returns a new vector that is the linear blend of the 2 given vectors.
Declaration
public static void Lerp(in Vector2 a, in Vector2 b, float blend, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First input vector. |
Vector2 | b | Second input vector. |
float | blend | The blend factor. |
Vector2 | result | a when blend=0, b when blend=1, and a linear combination otherwise. |
MagnitudeMax(Vector2, Vector2)
Returns the Vector2 with the maximum magnitude. If the magnitudes are equal, the first vector is selected.
Declaration
[Pure]
public static Vector2 MagnitudeMax(Vector2 left, Vector2 right)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | Left operand. |
Vector2 | right | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | The maximum Vector2. |
MagnitudeMax(in Vector2, in Vector2, out Vector2)
Returns the Vector2 with the maximum magnitude. If the magnitudes are equal, the first vector is selected.
Declaration
public static void MagnitudeMax(in Vector2 left, in Vector2 right, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | Left operand. |
Vector2 | right | Right operand. |
Vector2 | result | The magnitude-wise maximum. |
MagnitudeMin(Vector2, Vector2)
Returns the Vector2 with the minimum magnitude. If the magnitudes are equal, the second vector is selected.
Declaration
[Pure]
public static Vector2 MagnitudeMin(Vector2 left, Vector2 right)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | Left operand. |
Vector2 | right | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | The minimum Vector2. |
MagnitudeMin(in Vector2, in Vector2, out Vector2)
Returns the Vector2 with the minimum magnitude. If the magnitudes are equal, the second vector is selected.
Declaration
public static void MagnitudeMin(in Vector2 left, in Vector2 right, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | Left operand. |
Vector2 | right | Right operand. |
Vector2 | result | The magnitude-wise minimum. |
Multiply(Vector2, Vector2)
Multiplies a vector by the components a vector (scale).
Declaration
[Pure]
public static Vector2 Multiply(Vector2 vector, Vector2 scale)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vector | Left operand. |
Vector2 | scale | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of the operation. |
Multiply(Vector2, float)
Multiplies a vector by a scalar.
Declaration
[Pure]
public static Vector2 Multiply(Vector2 vector, float scale)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vector | Left operand. |
float | scale | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of the operation. |
Multiply(in Vector2, in Vector2, out Vector2)
Multiplies a vector by the components of a vector (scale).
Declaration
public static void Multiply(in Vector2 vector, in Vector2 scale, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vector | Left operand. |
Vector2 | scale | Right operand. |
Vector2 | result | Result of the operation. |
Multiply(in Vector2, float, out Vector2)
Multiplies a vector by a scalar.
Declaration
public static void Multiply(in Vector2 vector, float scale, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vector | Left operand. |
float | scale | Right operand. |
Vector2 | result | Result of the operation. |
Normalize()
Scales the Vector2 to unit length.
Declaration
public void Normalize()
Normalize(Vector2)
Scale a vector to unit length.
Declaration
[Pure]
public static Vector2 Normalize(Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The input vector. |
Returns
Type | Description |
---|---|
Vector2 | The normalized copy. |
Normalize(in Vector2, out Vector2)
Scale a vector to unit length.
Declaration
public static void Normalize(in Vector2 vec, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The input vector. |
Vector2 | result | The normalized vector. |
Normalized()
Returns a copy of the Vector2 scaled to unit length.
Declaration
public Vector2 Normalized()
Returns
Type | Description |
---|---|
Vector2 | The normalized copy. |
NormalizeFast()
Scales the Vector2 to approximately unit length.
Declaration
public void NormalizeFast()
NormalizeFast(Vector2)
Scale a vector to approximately unit length.
Declaration
[Pure]
public static Vector2 NormalizeFast(Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The input vector. |
Returns
Type | Description |
---|---|
Vector2 | The normalized copy. |
NormalizeFast(in Vector2, out Vector2)
Scale a vector to approximately unit length.
Declaration
public static void NormalizeFast(in Vector2 vec, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The input vector. |
Vector2 | result | The normalized vector. |
PerpDot(Vector2, Vector2)
Calculate the perpendicular dot (scalar) product of two vectors.
Declaration
[Pure]
public static float PerpDot(Vector2 left, Vector2 right)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | First operand. |
Vector2 | right | Second operand. |
Returns
Type | Description |
---|---|
float | The perpendicular dot product of the two inputs. |
PerpDot(in Vector2, in Vector2, out float)
Calculate the perpendicular dot (scalar) product of two vectors.
Declaration
public static void PerpDot(in Vector2 left, in Vector2 right, out float result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | First operand. |
Vector2 | right | Second operand. |
float | result | The perpendicular dot product of the two inputs. |
Subtract(Vector2, Vector2)
Subtract one Vector from another.
Declaration
[Pure]
public static Vector2 Subtract(Vector2 a, Vector2 b)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First operand. |
Vector2 | b | Second operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of subtraction. |
Subtract(in Vector2, in Vector2, out Vector2)
Subtract one Vector from another.
Declaration
public static void Subtract(in Vector2 a, in Vector2 b, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | a | First operand. |
Vector2 | b | Second operand. |
Vector2 | result | Result of subtraction. |
ToString()
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
ToString(IFormatProvider)
Declaration
public string ToString(IFormatProvider formatProvider)
Parameters
Type | Name | Description |
---|---|---|
IFormatProvider | formatProvider |
Returns
Type | Description |
---|---|
string |
ToString(string, IFormatProvider)
Declaration
public string ToString(string format, IFormatProvider formatProvider)
Parameters
Type | Name | Description |
---|---|---|
string | format | |
IFormatProvider | formatProvider |
Returns
Type | Description |
---|---|
string |
ToString(string)
Declaration
public string ToString(string format)
Parameters
Type | Name | Description |
---|---|---|
string | format |
Returns
Type | Description |
---|---|
string |
Transform(Vector2, Quaternion)
Transforms a vector by a quaternion rotation.
Declaration
[Pure]
public static Vector2 Transform(Vector2 vec, Quaternion quat)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The vector to transform. |
Quaternion | quat | The quaternion to rotate the vector by. |
Returns
Type | Description |
---|---|
Vector2 | The result of the operation. |
Transform(in Vector2, in Quaternion, out Vector2)
Transforms a vector by a quaternion rotation.
Declaration
public static void Transform(in Vector2 vec, in Quaternion quat, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The vector to transform. |
Quaternion | quat | The quaternion to rotate the vector by. |
Vector2 | result | The result of the operation. |
TransformColumn(Matrix2, Vector2)
Transform a Vector by the given Matrix using right-handed notation.
Declaration
[Pure]
public static Vector2 TransformColumn(Matrix2 mat, Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Matrix2 | mat | The desired transformation. |
Vector2 | vec | The vector to transform. |
Returns
Type | Description |
---|---|
Vector2 | The transformed vector. |
TransformColumn(in Matrix2, in Vector2, out Vector2)
Transform a Vector by the given Matrix using right-handed notation.
Declaration
public static void TransformColumn(in Matrix2 mat, in Vector2 vec, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Matrix2 | mat | The desired transformation. |
Vector2 | vec | The vector to transform. |
Vector2 | result | The transformed vector. |
TransformRow(Vector2, Matrix2)
Transform a Vector by the given Matrix.
Declaration
[Pure]
public static Vector2 TransformRow(Vector2 vec, Matrix2 mat)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The vector to transform. |
Matrix2 | mat | The desired transformation. |
Returns
Type | Description |
---|---|
Vector2 | The transformed vector. |
TransformRow(in Vector2, in Matrix2, out Vector2)
Transform a Vector by the given Matrix.
Declaration
public static void TransformRow(in Vector2 vec, in Matrix2 mat, out Vector2 result)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The vector to transform. |
Matrix2 | mat | The desired transformation. |
Vector2 | result | The transformed vector. |
Operators
operator +(Vector2, Vector2)
Adds the specified instances.
Declaration
[Pure]
public static Vector2 operator +(Vector2 left, Vector2 right)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | Left operand. |
Vector2 | right | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of addition. |
operator /(Vector2, Vector2)
Component-wise division between the specified instance by a scale vector.
Declaration
[Pure]
public static Vector2 operator /(Vector2 vec, Vector2 scale)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | Left operand. |
Vector2 | scale | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of the division. |
operator /(Vector2, float)
Divides the specified instance by a scalar.
Declaration
[Pure]
public static Vector2 operator /(Vector2 vec, float scale)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | Left operand. |
float | scale | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of the division. |
operator ==(Vector2, Vector2)
Compares the specified instances for equality.
Declaration
public static bool operator ==(Vector2 left, Vector2 right)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | Left operand. |
Vector2 | right | Right operand. |
Returns
Type | Description |
---|---|
bool | True if both instances are equal; false otherwise. |
explicit operator Vector2h(Vector2)
Converts OpenTK.Vector2 to OpenTK.Vector2h.
Declaration
[Pure]
public static explicit operator Vector2h(Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The Vector2 to convert. |
Returns
Type | Description |
---|---|
Vector2h | The resulting Vector2h. |
explicit operator Vector2i(Vector2)
Converts OpenTK.Vector2 to OpenTK.Vector2i.
Declaration
[Pure]
public static explicit operator Vector2i(Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The Vector2 to convert. |
Returns
Type | Description |
---|---|
Vector2i | The resulting Vector2i. |
explicit operator PointF(Vector2)
Declaration
[Pure]
public static explicit operator PointF(Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The Vector2 to cast. |
Returns
Type | Description |
---|---|
PointF | The resulting PointF. |
explicit operator SizeF(Vector2)
Declaration
[Pure]
public static explicit operator SizeF(Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The Vector2 to cast. |
Returns
Type | Description |
---|---|
SizeF | The resulting SizeF. |
implicit operator Vector2d(Vector2)
Converts OpenTK.Vector2 to OpenTK.Vector2d.
Declaration
[Pure]
public static implicit operator Vector2d(Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The Vector2 to convert. |
Returns
Type | Description |
---|---|
Vector2d | The resulting Vector2d. |
implicit operator Vector2((float X, float Y))
Initializes a new instance of the Vector2 struct using a tuple containing the component values.
Declaration
[Pure]
public static implicit operator Vector2((float X, float Y) values)
Parameters
Type | Name | Description |
---|---|---|
(float X, float Y) | values | A tuple containing the component values. |
Returns
Type | Description |
---|---|
Vector2 | A new instance of the Vector2 struct with the given component values. |
operator !=(Vector2, Vector2)
Compares the specified instances for inequality.
Declaration
public static bool operator !=(Vector2 left, Vector2 right)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | Left operand. |
Vector2 | right | Right operand. |
Returns
Type | Description |
---|---|
bool | True if both instances are not equal; false otherwise. |
operator *(Matrix2, Vector2)
Transform a Vector by the given Matrix using right-handed notation.
Declaration
[Pure]
public static Vector2 operator *(Matrix2 mat, Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Matrix2 | mat | The desired transformation. |
Vector2 | vec | The vector to transform. |
Returns
Type | Description |
---|---|
Vector2 | The transformed vector. |
operator *(Quaternion, Vector2)
Transforms a vector by a quaternion rotation.
Declaration
[Pure]
public static Vector2 operator *(Quaternion quat, Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Quaternion | quat | The quaternion to rotate the vector by. |
Vector2 | vec | The vector to transform. |
Returns
Type | Description |
---|---|
Vector2 | The multiplied vector. |
operator *(Vector2, Matrix2)
Transform a Vector by the given Matrix.
Declaration
[Pure]
public static Vector2 operator *(Vector2 vec, Matrix2 mat)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | The vector to transform. |
Matrix2 | mat | The desired transformation. |
Returns
Type | Description |
---|---|
Vector2 | The transformed vector. |
operator *(Vector2, Vector2)
Component-wise multiplication between the specified instance by a scale vector.
Declaration
[Pure]
public static Vector2 operator *(Vector2 vec, Vector2 scale)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | Right operand. |
Vector2 | scale | Left operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of multiplication. |
operator *(Vector2, float)
Multiplies the specified instance by a scalar.
Declaration
[Pure]
public static Vector2 operator *(Vector2 vec, float scale)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | Left operand. |
float | scale | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of multiplication. |
operator *(float, Vector2)
Multiplies the specified instance by a scalar.
Declaration
[Pure]
public static Vector2 operator *(float scale, Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
float | scale | Left operand. |
Vector2 | vec | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of multiplication. |
operator -(Vector2, Vector2)
Subtracts the specified instances.
Declaration
[Pure]
public static Vector2 operator -(Vector2 left, Vector2 right)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | left | Left operand. |
Vector2 | right | Right operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of subtraction. |
operator -(Vector2)
Negates the specified instance.
Declaration
[Pure]
public static Vector2 operator -(Vector2 vec)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | vec | Operand. |
Returns
Type | Description |
---|---|
Vector2 | Result of negation. |