Struct Matrix2

Represents a 2x2 matrix.

Implements

IEquatable<Matrix2>

IFormattable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: OpenTK.Mathematics

Assembly: OpenTK.Mathematics.dll

Syntax

[Serializable]
public struct Matrix2 : IEquatable<Matrix2>, IFormattable

Constructors

Matrix2(Vector2, Vector2)

Initializes a new instance of the Matrix2 struct.

Declaration

public Matrix2(Vector2 row0, Vector2 row1)

Parameters

Type	Name	Description
Vector2	row0	Top row of the matrix.
Vector2	row1	Bottom row of the matrix.

Matrix2(float, float, float, float)

Initializes a new instance of the Matrix2 struct.

Declaration

public Matrix2(float m00, float m01, float m10, float m11)

Parameters

Type	Name	Description
float	m00	First item of the first row of the matrix.
float	m01	Second item of the first row of the matrix.
float	m10	First item of the second row of the matrix.
float	m11	Second item of the second row of the matrix.

Fields

Identity

The identity matrix.

Declaration

public static readonly Matrix2 Identity

Field Value

Type	Description
Matrix2

Row0

Top row of the matrix.

Declaration

public Vector2 Row0

Field Value

Type	Description
Vector2

Row1

Bottom row of the matrix.

Declaration

public Vector2 Row1

Field Value

Type	Description
Vector2

Zero

The zero matrix.

Declaration

public static readonly Matrix2 Zero

Field Value

Type	Description
Matrix2

Properties

Column0

Gets or sets the first column of this matrix.

Declaration

public Vector2 Column0 { readonly get; set; }

Property Value

Type	Description
Vector2

Column1

Gets or sets the second column of this matrix.

Declaration

public Vector2 Column1 { readonly get; set; }

Property Value

Type	Description
Vector2

Determinant

Gets the determinant of this matrix.

Declaration

public readonly float Determinant { get; }

Property Value

Type	Description
float

Diagonal

Gets or sets the values along the main diagonal of the matrix.

Declaration

public Vector2 Diagonal { readonly get; set; }

Property Value

Type	Description
Vector2

this[int, int]

Gets or sets the value at a specified row and column.

Declaration

public float this[int rowIndex, int columnIndex] { readonly get; set; }

Parameters

Type	Name	Description
int	rowIndex	The index of the row.
int	columnIndex	The index of the column.

Property Value

Type	Description
float	The element at the given row and column index.

M11

Gets or sets the value at row 1, column 1 of this instance.

Declaration

public float M11 { readonly get; set; }

Property Value

Type	Description
float

M12

Gets or sets the value at row 1, column 2 of this instance.

Declaration

public float M12 { readonly get; set; }

Property Value

Type	Description
float

M21

Gets or sets the value at row 2, column 1 of this instance.

Declaration

public float M21 { readonly get; set; }

Property Value

Type	Description
float

M22

Gets or sets the value at row 2, column 2 of this instance.

Declaration

public float M22 { readonly get; set; }

Property Value

Type	Description
float

Trace

Gets the trace of the matrix, the sum of the values along the diagonal.

Declaration

public readonly float Trace { get; }

Property Value

Type	Description
float

Methods

Add(Matrix2, Matrix2)

Adds two instances.

Declaration

[Pure]
public static Matrix2 Add(Matrix2 left, Matrix2 right)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the addition.
Matrix2	right	The right operand of the addition.

Returns

Type	Description
Matrix2	A new instance that is the result of the addition.

Add(in Matrix2, in Matrix2, out Matrix2)

Adds two instances.

Declaration

public static void Add(in Matrix2 left, in Matrix2 right, out Matrix2 result)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the addition.
Matrix2	right	The right operand of the addition.
Matrix2	result	A new instance that is the result of the addition.

CreateRotation(float)

Builds a rotation matrix.

Declaration

[Pure]
public static Matrix2 CreateRotation(float angle)

Parameters

Type	Name	Description
float	angle	The counter-clockwise angle in radians.

Returns

Type	Description
Matrix2	The resulting Matrix2 instance.

CreateRotation(float, out Matrix2)

Builds a rotation matrix.

Declaration

public static void CreateRotation(float angle, out Matrix2 result)

Parameters

Type	Name	Description
float	angle	The counter-clockwise angle in radians.
Matrix2	result	The resulting Matrix2 instance.

CreateScale(Vector2)

Creates a scale matrix.

Declaration

[Pure]
public static Matrix2 CreateScale(Vector2 scale)

Parameters

Type	Name	Description
Vector2	scale	Scale factors for the x and y axes.

Returns

Type	Description
Matrix2	A scale matrix.

CreateScale(Vector2, out Matrix2)

Creates a scale matrix.

Declaration

public static void CreateScale(Vector2 scale, out Matrix2 result)

Parameters

Type	Name	Description
Vector2	scale	Scale factors for the x and y axes.
Matrix2	result	A scale matrix.

CreateScale(float)

Creates a scale matrix.

Declaration

[Pure]
public static Matrix2 CreateScale(float scale)

Parameters

Type	Name	Description
float	scale	Single scale factor for the x and y axes.

Returns

Type	Description
Matrix2	A scale matrix.

CreateScale(float, out Matrix2)

Creates a scale matrix.

Declaration

public static void CreateScale(float scale, out Matrix2 result)

Parameters

Type	Name	Description
float	scale	Single scale factor for the x, y, and z axes.
Matrix2	result	A scale matrix.

CreateScale(float, float)

Creates a scale matrix.

Declaration

[Pure]
public static Matrix2 CreateScale(float x, float y)

Parameters

Type	Name	Description
float	x	Scale factor for the x axis.
float	y	Scale factor for the y axis.

Returns

Type	Description
Matrix2	A scale matrix.

CreateScale(float, float, out Matrix2)

Creates a scale matrix.

Declaration

public static void CreateScale(float x, float y, out Matrix2 result)

Parameters

Type	Name	Description
float	x	Scale factor for the x axis.
float	y	Scale factor for the y axis.
Matrix2	result	A scale matrix.

CreateSwizzle(int, int)

Create a swizzle matrix that can be used to change the row order of matrices.

Declaration

public static Matrix2 CreateSwizzle(int rowForRow0, int rowForRow1)

Parameters

Type	Name	Description
int	rowForRow0	Which row to place in Row0.
int	rowForRow1	Which row to place in Row1.

Returns

Type	Description
Matrix2	The resulting swizzle matrix.

Remarks

If you are looking to swizzle vectors there are properties like Yx that can do this more effectively.

CreateSwizzle(int, int, out Matrix2)

Create a swizzle matrix that can be used to change the row order of matrices.

Declaration

public static void CreateSwizzle(int rowForRow0, int rowForRow1, out Matrix2 result)

Parameters

Type	Name	Description
int	rowForRow0	Which row to place in Row0.
int	rowForRow1	Which row to place in Row1.
Matrix2	result	The resulting swizzle matrix.

Remarks

If you are looking to swizzle vectors there are properties like Yx that can do this more effectively.

Equals(Matrix2)

Indicates whether the current matrix is equal to another matrix.

Declaration

[Pure]
public readonly bool Equals(Matrix2 other)

Parameters

Type	Name	Description
Matrix2	other	An matrix to compare with this matrix.

Returns

Type	Description
bool	true if the current matrix is equal to the matrix parameter; otherwise, false.

Equals(object)

Indicates whether this instance and a specified object are equal.

Declaration

[Pure]
public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare to.

Returns

Type	Description
bool	True if the instances are equal; false otherwise.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hashcode for this instance.

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int	A System.Int32 containing the unique hashcode for this instance.

Overrides

ValueType.GetHashCode()

Invert()

Converts this instance into its inverse.

Declaration

public void Invert()

Invert(Matrix2)

Calculate the inverse of the given matrix.

Declaration

[Pure]
public static Matrix2 Invert(Matrix2 mat)

Parameters

Type	Name	Description
Matrix2	mat	The matrix to invert.

Returns

Type	Description
Matrix2	The inverse of the given matrix.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the Matrix2 is singular.

Invert(in Matrix2, out Matrix2)

Calculate the inverse of the given matrix.

Declaration

public static void Invert(in Matrix2 mat, out Matrix2 result)

Parameters

Type	Name	Description
Matrix2	mat	The matrix to invert.
Matrix2	result	The inverse of the given matrix.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the Matrix2 is singular.

Inverted()

Returns an inverted copy of this instance.

Declaration

public readonly Matrix2 Inverted()

Returns

Type	Description
Matrix2	The inverted copy.

Mult(Matrix2, Matrix2)

Multiplies two instances.

Declaration

[Pure]
public static Matrix2 Mult(Matrix2 left, Matrix2 right)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the multiplication.
Matrix2	right	The right operand of the multiplication.

Returns

Type	Description
Matrix2	A new instance that is the result of the multiplication.

Mult(Matrix2, Matrix2x3)

Multiplies two instances.

Declaration

[Pure]
public static Matrix2x3 Mult(Matrix2 left, Matrix2x3 right)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the multiplication.
Matrix2x3	right	The right operand of the multiplication.

Returns

Type	Description
Matrix2x3	A new instance that is the result of the multiplication.

Mult(Matrix2, Matrix2x4)

Multiplies two instances.

Declaration

[Pure]
public static Matrix2x4 Mult(Matrix2 left, Matrix2x4 right)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the multiplication.
Matrix2x4	right	The right operand of the multiplication.

Returns

Type	Description
Matrix2x4	A new instance that is the result of the multiplication.

Mult(Matrix2, float)

Multiplies and instance by a scalar.

Declaration

[Pure]
public static Matrix2 Mult(Matrix2 left, float right)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the multiplication.
float	right	The right operand of the multiplication.

Returns

Type	Description
Matrix2	A new instance that is the result of the multiplication.

Mult(in Matrix2, in Matrix2, out Matrix2)

Multiplies two instances.

Declaration

public static void Mult(in Matrix2 left, in Matrix2 right, out Matrix2 result)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the multiplication.
Matrix2	right	The right operand of the multiplication.
Matrix2	result	A new instance that is the result of the multiplication.

Mult(in Matrix2, in Matrix2x3, out Matrix2x3)

Multiplies two instances.

Declaration

public static void Mult(in Matrix2 left, in Matrix2x3 right, out Matrix2x3 result)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the multiplication.
Matrix2x3	right	The right operand of the multiplication.
Matrix2x3	result	A new instance that is the result of the multiplication.

Mult(in Matrix2, in Matrix2x4, out Matrix2x4)

Multiplies two instances.

Declaration

public static void Mult(in Matrix2 left, in Matrix2x4 right, out Matrix2x4 result)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the multiplication.
Matrix2x4	right	The right operand of the multiplication.
Matrix2x4	result	A new instance that is the result of the multiplication.

Mult(in Matrix2, float, out Matrix2)

Multiplies and instance by a scalar.

Declaration

public static void Mult(in Matrix2 left, float right, out Matrix2 result)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the multiplication.
float	right	The right operand of the multiplication.
Matrix2	result	A new instance that is the result of the multiplication.

Subtract(Matrix2, Matrix2)

Subtracts two instances.

Declaration

[Pure]
public static Matrix2 Subtract(Matrix2 left, Matrix2 right)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the subtraction.
Matrix2	right	The right operand of the subtraction.

Returns

Type	Description
Matrix2	A new instance that is the result of the subtraction.

Subtract(in Matrix2, in Matrix2, out Matrix2)

Subtracts two instances.

Declaration

public static void Subtract(in Matrix2 left, in Matrix2 right, out Matrix2 result)

Parameters

Type	Name	Description
Matrix2	left	The left operand of the subtraction.
Matrix2	right	The right operand of the subtraction.
Matrix2	result	A new instance that is the result of the subtraction.

Swizzle(Matrix2, int, int)

Swizzles a matrix, i.e. switches rows of the matrix.

Declaration

public static Matrix2 Swizzle(Matrix2 mat, int rowForRow0, int rowForRow1)

Parameters

Type	Name	Description
Matrix2	mat	The matrix to swizzle.
int	rowForRow0	Which row to place in Row0.
int	rowForRow1	Which row to place in Row1.

Returns

Type	Description
Matrix2	The swizzled matrix.

Exceptions

Type	Condition
IndexOutOfRangeException	If any of the rows are outside of the range [0, 1].

Swizzle(in Matrix2, int, int, out Matrix2)

Swizzles a matrix, i.e. switches rows of the matrix.

Declaration

public static void Swizzle(in Matrix2 mat, int rowForRow0, int rowForRow1, out Matrix2 result)

Parameters

Type	Name	Description
Matrix2	mat	The matrix to swizzle.
int	rowForRow0	Which row to place in Row0.
int	rowForRow1	Which row to place in Row1.
Matrix2	result	The swizzled matrix.

Exceptions

Type	Condition
IndexOutOfRangeException	If any of the rows are outside of the range [0, 1].

Swizzle(int, int)

Swizzles this instance. Swiches places of the rows of the matrix.

Declaration

public void Swizzle(int rowForRow0, int rowForRow1)

Parameters

Type	Name	Description
int	rowForRow0	Which row to place in Row0.
int	rowForRow1	Which row to place in Row1.

Swizzled(int, int)

Returns a swizzled copy of this instance.

Declaration

public readonly Matrix2 Swizzled(int rowForRow0, int rowForRow1)

Parameters

Type	Name	Description
int	rowForRow0	Which row to place in Row0.
int	rowForRow1	Which row to place in Row1.

Returns

Type	Description
Matrix2	The swizzled copy.

ToString()

Returns a System.String that represents the current Matrix4.

Declaration

public override readonly string ToString()

Returns

Type	Description
string	The string representation of the matrix.

Overrides

ValueType.ToString()

ToString(IFormatProvider)

Formats the value of the current instance using the specified format.

Declaration

public readonly string ToString(IFormatProvider formatProvider)

Parameters

Type	Name	Description
IFormatProvider	formatProvider	The provider to use to format the value. -or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

Type	Description
string	The value of the current instance in the specified format.

ToString(string)

Formats the value of the current instance using the specified format.

Declaration

public readonly string ToString(string format)

Parameters

Type	Name	Description
string	format	The format to use. -or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

Returns

Type	Description
string	The value of the current instance in the specified format.

ToString(string, IFormatProvider)

Formats the value of the current instance using the specified format.

Declaration

public readonly string ToString(string format, IFormatProvider formatProvider)

Parameters

Type	Name	Description
string	format	The format to use. -or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.
IFormatProvider	formatProvider	The provider to use to format the value. -or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

Type	Description
string	The value of the current instance in the specified format.

Transpose()

Converts this instance to it's transpose.

Declaration

public void Transpose()

Transpose(Matrix2)

Calculate the transpose of the given matrix.

Declaration

[Pure]
public static Matrix2 Transpose(Matrix2 mat)

Parameters

Type	Name	Description
Matrix2	mat	The matrix to transpose.

Returns

Type	Description
Matrix2	The transpose of the given matrix.

Transpose(in Matrix2, out Matrix2)

Calculate the transpose of the given matrix.

Declaration

public static void Transpose(in Matrix2 mat, out Matrix2 result)

Parameters

Type	Name	Description
Matrix2	mat	The matrix to transpose.
Matrix2	result	The transpose of the given matrix.

Transposed()

Returns a transposed copy of this instance.

Declaration

public readonly Matrix2 Transposed()

Returns

Type	Description
Matrix2	The transposed copy.

Operators

operator +(Matrix2, Matrix2)

Matrix addition.

Declaration

[Pure]
public static Matrix2 operator +(Matrix2 left, Matrix2 right)

Parameters

Type	Name	Description
Matrix2	left	left-hand operand.
Matrix2	right	right-hand operand.

Returns

Type	Description
Matrix2	A new Matrix2 which holds the result of the addition.

operator ==(Matrix2, Matrix2)

Compares two instances for equality.

Declaration

[Pure]
public static bool operator ==(Matrix2 left, Matrix2 right)

Parameters

Type	Name	Description
Matrix2	left	The first instance.
Matrix2	right	The second instance.

Returns

Type	Description
bool	True, if left equals right; false otherwise.

operator !=(Matrix2, Matrix2)

Compares two instances for inequality.

Declaration

[Pure]
public static bool operator !=(Matrix2 left, Matrix2 right)

Parameters

Type	Name	Description
Matrix2	left	The first instance.
Matrix2	right	The second instance.

Returns

Type	Description
bool	True, if left does not equal right; false otherwise.

operator *(Matrix2, Matrix2)

Matrix multiplication.

Declaration

[Pure]
public static Matrix2 operator *(Matrix2 left, Matrix2 right)

Parameters

Type	Name	Description
Matrix2	left	left-hand operand.
Matrix2	right	right-hand operand.

Returns

Type	Description
Matrix2	A new Matrix2 which holds the result of the multiplication.

operator *(Matrix2, Matrix2x3)

Matrix multiplication.

Declaration

[Pure]
public static Matrix2x3 operator *(Matrix2 left, Matrix2x3 right)

Parameters

Type	Name	Description
Matrix2	left	left-hand operand.
Matrix2x3	right	right-hand operand.

Returns

Type	Description
Matrix2x3	A new Matrix2x3 which holds the result of the multiplication.

operator *(Matrix2, Matrix2x4)

Matrix multiplication.

Declaration

[Pure]
public static Matrix2x4 operator *(Matrix2 left, Matrix2x4 right)

Parameters

Type	Name	Description
Matrix2	left	left-hand operand.
Matrix2x4	right	right-hand operand.

Returns

Type	Description
Matrix2x4	A new Matrix2x4 which holds the result of the multiplication.

operator *(Matrix2, float)

Scalar multiplication.

Declaration

[Pure]
public static Matrix2 operator *(Matrix2 left, float right)

Parameters

Type	Name	Description
Matrix2	left	left-hand operand.
float	right	right-hand operand.

Returns

Type	Description
Matrix2	A new Matrix2 which holds the result of the multiplication.

operator *(float, Matrix2)

Scalar multiplication.

Declaration

[Pure]
public static Matrix2 operator *(float left, Matrix2 right)

Parameters

Type	Name	Description
float	left	left-hand operand.
Matrix2	right	right-hand operand.

Returns

Type	Description
Matrix2	A new Matrix2 which holds the result of the multiplication.

operator -(Matrix2, Matrix2)

Matrix subtraction.

Declaration

[Pure]
public static Matrix2 operator -(Matrix2 left, Matrix2 right)

Parameters

Type	Name	Description
Matrix2	left	left-hand operand.
Matrix2	right	right-hand operand.

Returns

Type	Description
Matrix2	A new Matrix2 which holds the result of the subtraction.

Implements

IEquatable<T>

IFormattable