Class Matrix

StereoKit/Math/Matrix.cs:29–508

A Matrix in StereoKit is a 4x4 grid of numbers that is used to represent a transformation for any sort of position or vector! This is an oversimplification of what a matrix actually is, but it's accurate in this case. Matrices are really useful for transforms because you can chain together all sorts of transforms into a single Matrix! A Matrix transform really shines when applied to many

	/// Matrices are prominently used within shaders for mesh transforms!
	/// </summary>
	public struct Matrix
	{
		/// <summary>The internal, wrapped System.Numerics type. This can be
		/// nice to have around so you can pass its fields as 'ref', which you
		/// can't do with properties. You won't often need this, as implicit
		/// conversions to System.Numerics types are also provided.</summary>
		public Matrix4x4 m;

		/// <summary>This constructor is for manually creating a matrix from a
		/// grid of floats! You'll likely want to use one of the static Matrix
		/// functions to create a Matrix instead.</summary>
		/// <param name="m11">m11</param>
		/// <param name="m12">m12</param>
		/// <param name="m13">m13</param>
		/// <param name="m14">m14</param>
		/// <param name="m21">m21</param>
		/// <param name="m22">m22</param>
		/// <param name="m23">m23</param>
		/// <param name="m24">m24</param>
		/// <param name="m31">m31</param>
		/// <param name="m32">m32</param>
		/// <param name="m33">m33</param>
		/// <param name="m34">m34</param>
		/// <param name="m41">m41</param>
		/// <param name="m42">m42</param>
		/// <param name="m43">m43</param>
		/// <param name="m44">m44</param>
		public Matrix(float m11, float m12, float m13, float m14, float m21, float m22, float m23, float m24, float m31, float m32, float m33, float m34, float m41, float m42, float m43, float m44)
			=> m = new Matrix4x4(
				m11, m12, m13, m14,
				m21, m22, m23, m24,
				m31, m32, m33, m34,
				m41, m42, m43, m44);
		/// <summary>Create a Matrix from the equivalent System.Numerics Matrix
		/// type. You can also implicitly convert between these types, as this
		/// Matrix is backed by the System.Numerics type anyhow.</summary>
		/// <param name="matrix">A System.Numerics matrix.</param>
		public Matrix(Matrix4x4 matrix)
			=> m = matrix;

		/// <summary>Allows implicit conversion from System.Numerics.Matrix4x4
		/// to StereoKit.Matrix.</summary>
		/// <param name="m">Any System.Numerics Matrix4x4.</param>
		/// <returns>A StereoKit compatible matrix.</returns>
		public static implicit operator Matrix(Matrix4x4 m) => new Matrix(m);
		/// <summary>Allows implicit conversion from StereoKit.Matrix to
		/// System.Numerics.Matrix4x4</summary>
		/// <param name="m">Any StereoKit.Matrix.</param>
		/// <returns>A System.Numerics compatible matrix.</returns>
		public static implicit operator Matrix4x4(Matrix m) => m.m;

		/// <summary>Multiplies two matrices together! This is a great way to
		/// combine transform operations. Note that StereoKit's matrices are
		/// row-major, and multiplication order is important! To translate,
		/// then scale, multiply in order of 'translate * scale'.</summary>
		/// <param name="a">First Matrix.</param>
		/// <param name="b">Second Matrix.</param>
		/// <returns>Result of matrix multiplication.</returns>