Struct Matrix3x4

Represents a 3x4 Matrix

Implements

IEquatable<Matrix3x4>

Inherited Members

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: OpenTK

Assembly: OpenTK.dll

Syntax

[Serializable]
public struct Matrix3x4 : IEquatable<Matrix3x4>

Constructors

Matrix3x4(Vector4, Vector4, Vector4)

Constructs a new instance.

Declaration

public Matrix3x4(Vector4 row0, Vector4 row1, Vector4 row2)

Parameters

Type	Name	Description
Vector4	row0	Top row of the matrix
Vector4	row1	Second row of the matrix
Vector4	row2	Bottom row of the matrix

Matrix3x4(Single, Single, Single, Single, Single, Single, Single, Single, Single, Single, Single, Single)

Constructs a new instance.

Declaration

public Matrix3x4(float m00, float m01, float m02, float m03, float m10, float m11, float m12, float m13, float m20, float m21, float m22, float m23)

Parameters

Type	Name	Description
Single	m00	First item of the first row of the matrix.
Single	m01	Second item of the first row of the matrix.
Single	m02	Third item of the first row of the matrix.
Single	m03	Fourth item of the first row of the matrix.
Single	m10	First item of the second row of the matrix.
Single	m11	Second item of the second row of the matrix.
Single	m12	Third item of the second row of the matrix.
Single	m13	Fourth item of the second row of the matrix.
Single	m20	First item of the third row of the matrix.
Single	m21	Second item of the third row of the matrix.
Single	m22	Third item of the third row of the matrix.
Single	m23	First item of the third row of the matrix.

Fields

Row0

Top row of the matrix

Declaration

public Vector4 Row0

Field Value

Type	Description
Vector4

Row1

2nd row of the matrix

Declaration

public Vector4 Row1

Field Value

Type	Description
Vector4

Row2

Bottom row of the matrix

Declaration

public Vector4 Row2

Field Value

Type	Description
Vector4

Zero

The zero matrix

Declaration

public static Matrix3x4 Zero

Field Value

Type	Description
Matrix3x4

Properties

Column0

Gets the first column of this matrix.

Declaration

public readonly Vector3 Column0 { get; }

Property Value

Type	Description
Vector3

Column1

Gets the second column of this matrix.

Declaration

public readonly Vector3 Column1 { get; }

Property Value

Type	Description
Vector3

Column2

Gets the third column of this matrix.

Declaration

public readonly Vector3 Column2 { get; }

Property Value

Type	Description
Vector3

Column3

Gets the fourth column of this matrix.

Declaration

public readonly Vector3 Column3 { get; }

Property Value

Type	Description
Vector3

Diagonal

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

Declaration

public Vector3 Diagonal { get; set; }

Property Value

Type	Description
Vector3

Item[Int32, Int32]

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

Declaration

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

Parameters

Type	Name	Description
Int32	rowIndex
Int32	columnIndex

Property Value

Type	Description
Single

M11

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

Declaration

public float M11 { get; set; }

Property Value

Type	Description
Single

M12

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

Declaration

public float M12 { get; set; }

Property Value

Type	Description
Single

M13

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

Declaration

public float M13 { get; set; }

Property Value

Type	Description
Single

M14

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

Declaration

public float M14 { get; set; }

Property Value

Type	Description
Single

M21

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

Declaration

public float M21 { get; set; }

Property Value

Type	Description
Single

M22

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

Declaration

public float M22 { get; set; }

Property Value

Type	Description
Single

M23

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

Declaration

public float M23 { get; set; }

Property Value

Type	Description
Single

M24

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

Declaration

public float M24 { get; set; }

Property Value

Type	Description
Single

M31

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

Declaration

public float M31 { get; set; }

Property Value

Type	Description
Single

M32

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

Declaration

public float M32 { get; set; }

Property Value

Type	Description
Single

M33

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

Declaration

public float M33 { get; set; }

Property Value

Type	Description
Single

M34

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

Declaration

public float M34 { get; set; }

Property Value

Type	Description
Single

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
Single

Methods

Add(Matrix3x4, Matrix3x4)

Adds two instances.

Declaration

public static Matrix3x4 Add(Matrix3x4 left, Matrix3x4 right)

Parameters

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

Returns

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

Add(ref Matrix3x4, ref Matrix3x4, out Matrix3x4)

Adds two instances.

Declaration

public static void Add(ref Matrix3x4 left, ref Matrix3x4 right, out Matrix3x4 result)

Parameters

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

CreateFromAxisAngle(Vector3, Single)

Build a rotation matrix from the specified axis/angle rotation.

Declaration

public static Matrix3x4 CreateFromAxisAngle(Vector3 axis, float angle)

Parameters

Type	Name	Description
Vector3	axis	The axis to rotate about.
Single	angle	Angle in radians to rotate counter-clockwise (looking in the direction of the given axis).

Returns

Type	Description
Matrix3x4	A matrix instance.

CreateFromAxisAngle(Vector3, Single, out Matrix3x4)

Build a rotation matrix from the specified axis/angle rotation.

Declaration

public static void CreateFromAxisAngle(Vector3 axis, float angle, out Matrix3x4 result)

Parameters

Type	Name	Description
Vector3	axis	The axis to rotate about.
Single	angle	Angle in radians to rotate counter-clockwise (looking in the direction of the given axis).
Matrix3x4	result	A matrix instance.

CreateFromQuaternion(Quaternion)

Builds a rotation matrix from a quaternion.

Declaration

public static Matrix3x4 CreateFromQuaternion(Quaternion q)

Parameters

Type	Name	Description
Quaternion	q	The quaternion to rotate by.

Returns

Type	Description
Matrix3x4	A matrix instance.

CreateFromQuaternion(ref Quaternion, out Matrix3x4)

Builds a rotation matrix from a quaternion.

Declaration

public static void CreateFromQuaternion(ref Quaternion q, out Matrix3x4 result)

Parameters

Type	Name	Description
Quaternion	q	The quaternion to rotate by.
Matrix3x4	result	A matrix instance.

CreateRotationX(Single)

Builds a rotation matrix for a rotation around the x-axis.

Declaration

public static Matrix3x4 CreateRotationX(float angle)

Parameters

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

Returns

Type	Description
Matrix3x4	The resulting Matrix4 instance.

CreateRotationX(Single, out Matrix3x4)

Builds a rotation matrix for a rotation around the x-axis.

Declaration

public static void CreateRotationX(float angle, out Matrix3x4 result)

Parameters

Type	Name	Description
Single	angle	The counter-clockwise angle in radians.
Matrix3x4	result	The resulting Matrix4 instance.

CreateRotationY(Single)

Builds a rotation matrix for a rotation around the y-axis.

Declaration

public static Matrix3x4 CreateRotationY(float angle)

Parameters

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

Returns

Type	Description
Matrix3x4	The resulting Matrix4 instance.

CreateRotationY(Single, out Matrix3x4)

Builds a rotation matrix for a rotation around the y-axis.

Declaration

public static void CreateRotationY(float angle, out Matrix3x4 result)

Parameters

Type	Name	Description
Single	angle	The counter-clockwise angle in radians.
Matrix3x4	result	The resulting Matrix4 instance.

CreateRotationZ(Single)

Builds a rotation matrix for a rotation around the z-axis.

Declaration

public static Matrix3x4 CreateRotationZ(float angle)

Parameters

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

Returns

Type	Description
Matrix3x4	The resulting Matrix4 instance.

CreateRotationZ(Single, out Matrix3x4)

Builds a rotation matrix for a rotation around the z-axis.

Declaration

public static void CreateRotationZ(float angle, out Matrix3x4 result)

Parameters

Type	Name	Description
Single	angle	The counter-clockwise angle in radians.
Matrix3x4	result	The resulting Matrix4 instance.

CreateScale(Vector3)

Build a scaling matrix

Declaration

public static Matrix3x4 CreateScale(Vector3 scale)

Parameters

Type	Name	Description
Vector3	scale	Scale factors for x,y and z axes

Returns

Type	Description
Matrix3x4	A scaling matrix

CreateScale(Single)

Build a scaling matrix

Declaration

public static Matrix3x4 CreateScale(float scale)

Parameters

Type	Name	Description
Single	scale	Single scale factor for x,y and z axes

Returns

Type	Description
Matrix3x4	A scaling matrix

CreateScale(Single, Single, Single)

Build a scaling matrix

Declaration

public static Matrix3x4 CreateScale(float x, float y, float z)

Parameters

Type	Name	Description
Single	x	Scale factor for x-axis
Single	y	Scale factor for y-axis
Single	z	Scale factor for z-axis

Returns

Type	Description
Matrix3x4	A scaling matrix

CreateTranslation(Vector3)

Creates a translation matrix.

Declaration

public static Matrix3x4 CreateTranslation(Vector3 vector)

Parameters

Type	Name	Description
Vector3	vector	The translation vector.

Returns

Type	Description
Matrix3x4	The resulting Matrix4 instance.

CreateTranslation(ref Vector3, out Matrix3x4)

Creates a translation matrix.

Declaration

public static void CreateTranslation(ref Vector3 vector, out Matrix3x4 result)

Parameters

Type	Name	Description
Vector3	vector	The translation vector.
Matrix3x4	result	The resulting Matrix4 instance.

CreateTranslation(Single, Single, Single)

Creates a translation matrix.

Declaration

public static Matrix3x4 CreateTranslation(float x, float y, float z)

Parameters

Type	Name	Description
Single	x	X translation.
Single	y	Y translation.
Single	z	Z translation.

Returns

Type	Description
Matrix3x4	The resulting Matrix4 instance.

CreateTranslation(Single, Single, Single, out Matrix3x4)

Creates a translation matrix.

Declaration

public static void CreateTranslation(float x, float y, float z, out Matrix3x4 result)

Parameters

Type	Name	Description
Single	x	X translation.
Single	y	Y translation.
Single	z	Z translation.
Matrix3x4	result	The resulting Matrix4 instance.

Equals(Matrix3x4)

Indicates whether the current matrix is equal to another matrix.

Declaration

public bool Equals(Matrix3x4 other)

Parameters

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

Returns

Type	Description
Boolean	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

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare to.

Returns

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

Overrides

ValueType.Equals(Object)

GetHashCode()

Returns the hashcode for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	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(Matrix3x4)

Calculate the inverse of the given matrix

Declaration

public static Matrix3x4 Invert(Matrix3x4 mat)

Parameters

Type	Name	Description
Matrix3x4	mat	The matrix to invert

Returns

Type	Description
Matrix3x4	The inverse of the given matrix if it has one, or the input if it is singular

Exceptions

Type	Condition
InvalidOperationException	Thrown if the Matrix4 is singular.

Invert(ref Matrix3x4, out Matrix3x4)

Calculate the inverse of the given matrix

Declaration

public static void Invert(ref Matrix3x4 mat, out Matrix3x4 result)

Parameters

Type	Name	Description
Matrix3x4	mat	The matrix to invert
Matrix3x4	result	The inverse of the given matrix if it has one, or the input if it is singular

Exceptions

Type	Condition
InvalidOperationException	Thrown if the Matrix4 is singular.

Mult(Matrix3x4, Matrix3x4)

Multiplies two instances.

Declaration

public static Matrix3x4 Mult(Matrix3x4 left, Matrix3x4 right)

Parameters

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

Returns

Type	Description
Matrix3x4	A new instance that is the result of the multiplication

Mult(Matrix3x4, Matrix4x3)

Multiplies two instances.

Declaration

public static Matrix3 Mult(Matrix3x4 left, Matrix4x3 right)

Parameters

Type	Name	Description
Matrix3x4	left	The left operand of the multiplication.
Matrix4x3	right	The right operand of the multiplication.

Returns

Type	Description
Matrix3	A new instance that is the result of the multiplication

Mult(Matrix3x4, Single)

Multiplies an instance by a scalar.

Declaration

public static Matrix3x4 Mult(Matrix3x4 left, float right)

Parameters

Type	Name	Description
Matrix3x4	left	The left operand of the multiplication.
Single	right	The right operand of the multiplication.

Returns

Type	Description
Matrix3x4	A new instance that is the result of the multiplication

Mult(ref Matrix3x4, ref Matrix3x4, out Matrix3x4)

Multiplies two instances.

Declaration

public static void Mult(ref Matrix3x4 left, ref Matrix3x4 right, out Matrix3x4 result)

Parameters

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

Mult(ref Matrix3x4, ref Matrix4x3, out Matrix3)

Multiplies two instances.

Declaration

public static void Mult(ref Matrix3x4 left, ref Matrix4x3 right, out Matrix3 result)

Parameters

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

Mult(ref Matrix3x4, Single, out Matrix3x4)

Multiplies an instance by a scalar.

Declaration

public static void Mult(ref Matrix3x4 left, float right, out Matrix3x4 result)

Parameters

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

Subtract(Matrix3x4, Matrix3x4)

Subtracts one instance from another.

Declaration

public static Matrix3x4 Subtract(Matrix3x4 left, Matrix3x4 right)

Parameters

Type	Name	Description
Matrix3x4	left	The left operand of the subraction.
Matrix3x4	right	The right operand of the subraction.

Returns

Type	Description
Matrix3x4	A new instance that is the result of the subraction.

Subtract(ref Matrix3x4, ref Matrix3x4, out Matrix3x4)

Subtracts one instance from another.

Declaration

public static void Subtract(ref Matrix3x4 left, ref Matrix3x4 right, out Matrix3x4 result)

Parameters

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

ToString()

Returns a System.String that represents the current Matrix4.

Declaration

public override string ToString()

Returns

Type	Description
String	The string representation of the matrix.

Overrides

ValueType.ToString()

Transpose(Matrix3x4)

Calculate the transpose of the given matrix

Declaration

public static Matrix4x3 Transpose(Matrix3x4 mat)

Parameters

Type	Name	Description
Matrix3x4	mat	The matrix to transpose

Returns

Type	Description
Matrix4x3	The transpose of the given matrix

Transpose(ref Matrix3x4, out Matrix4x3)

Calculate the transpose of the given matrix

Declaration

public static void Transpose(ref Matrix3x4 mat, out Matrix4x3 result)

Parameters

Type	Name	Description
Matrix3x4	mat	The matrix to transpose
Matrix4x3	result	The result of the calculation

Operators

Addition(Matrix3x4, Matrix3x4)

Matrix addition

Declaration

public static Matrix3x4 operator +(Matrix3x4 left, Matrix3x4 right)

Parameters

Type	Name	Description
Matrix3x4	left	left-hand operand
Matrix3x4	right	right-hand operand

Returns

Type	Description
Matrix3x4	A new Matrix3x4 which holds the result of the addition

Equality(Matrix3x4, Matrix3x4)

Compares two instances for equality.

Declaration

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

Parameters

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

Returns

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

Inequality(Matrix3x4, Matrix3x4)

Compares two instances for inequality.

Declaration

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

Parameters

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

Returns

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

Multiply(Matrix3x4, Matrix3x4)

Matrix-scalar multiplication

Declaration

public static Matrix3x4 operator *(Matrix3x4 left, Matrix3x4 right)

Parameters

Type	Name	Description
Matrix3x4	left	left-hand operand
Matrix3x4	right	right-hand operand

Returns

Type	Description
Matrix3x4	A new Matrix3x4 which holds the result of the multiplication

Multiply(Matrix3x4, Matrix4x3)

Matrix multiplication

Declaration

public static Matrix3 operator *(Matrix3x4 left, Matrix4x3 right)

Parameters

Type	Name	Description
Matrix3x4	left	left-hand operand
Matrix4x3	right	right-hand operand

Returns

Type	Description
Matrix3	A new Matrix3 which holds the result of the multiplication

Multiply(Matrix3x4, Single)

Matrix-scalar multiplication

Declaration

public static Matrix3x4 operator *(Matrix3x4 left, float right)

Parameters

Type	Name	Description
Matrix3x4	left	left-hand operand
Single	right	right-hand operand

Returns

Type	Description
Matrix3x4	A new Matrix3x4 which holds the result of the multiplication

Subtraction(Matrix3x4, Matrix3x4)

Matrix subtraction

Declaration

public static Matrix3x4 operator -(Matrix3x4 left, Matrix3x4 right)

Parameters

Type	Name	Description
Matrix3x4	left	left-hand operand
Matrix3x4	right	right-hand operand

Returns

Type	Description
Matrix3x4	A new Matrix3x4 which holds the result of the subtraction

Implements

System.IEquatable<T>