mat2

Documentation

Overview

Package mat2 contains a 2x2 float32 matrix type T and functions.

Index

• Variables
• type T
  • func From(other generic.T) T
  • func Parse(s string) (r T, err error)
  • func (mat *T) Array() *[4]float32
  • func (mat *T) AssignMul(a, b *T) *T
  • func (mat *T) Cols() int
  • func (mat *T) Get(col, row int) float32
  • func (mat *T) IsZero() bool
  • func (mat *T) MulVec2(v *vec2.T) vec2.T
  • func (mat *T) Rows() int
  • func (mat *T) Scale(f float32) *T
  • func (mat *T) Scaled(f float32) T
  • func (mat *T) Scaling() vec2.T
  • func (mat *T) SetScaling(s *vec2.T) *T
  • func (mat *T) Size() int
  • func (mat *T) Slice() []float32
  • func (mat *T) String() string
  • func (mat *T) Trace() float32
  • func (mat *T) TransformVec2(v *vec2.T)
  • func (mat *T) Transpose() *T

Variables

var (
	// Zero holds a zero matrix.
	Zero = T{}

	// Ident holds an ident matrix.
	Ident = T{
		vec2.T{1, 0},
		vec2.T{0, 1},
	}
)

Types

type T

type T [2]vec2.T

T represents a 2x2 matrix.

func From

func From(other generic.T) T

From copies a T from a generic.T implementation.

func Parse

func Parse(s string) (r T, err error)

Parse parses T from a string. See also String()

func (*T) Array

func (mat *T) Array() *[4]float32

Array returns the elements of the matrix as array pointer. The data may be a copy depending on the platform implementation.

func (*T) AssignMul

func (mat *T) AssignMul(a, b *T) *T

AssignMul multiplies a and b and assigns the result to mat.

func (*T) Cols

func (mat *T) Cols() int

Cols returns the number of columns of the matrix.

func (*T) Get

func (mat *T) Get(col, row int) float32

Get returns one element of the matrix.

func (*T) IsZero

func (mat *T) IsZero() bool

IsZero checks if all elements of the matrix are zero.

func (*T) MulVec2

func (mat *T) MulVec2(v *vec2.T) vec2.T

MulVec2 multiplies vec with mat.

func (*T) Rows

func (mat *T) Rows() int

Rows returns the number of rows of the matrix.

func (*T) Scale

func (mat *T) Scale(f float32) *T

Scale multiplies the diagonal scale elements by f returns mat.

func (*T) Scaled

func (mat *T) Scaled(f float32) T

Scaled returns a copy of the matrix with the diagonal scale elements multiplied by f.

func (*T) Scaling

func (mat *T) Scaling() vec2.T

Scaling returns the scaling diagonal of the matrix.

func (*T) SetScaling

func (mat *T) SetScaling(s *vec2.T) *T

SetScaling sets the scaling diagonal of the matrix.

func (*T) Size

func (mat *T) Size() int

Size returns the number elements of the matrix.

func (*T) Slice

func (mat *T) Slice() []float32

Slice returns the elements of the matrix as slice. The data may be a copy depending on the platform implementation.

func (*T) String

func (mat *T) String() string

String formats T as string. See also Parse().

func (*T) Trace

func (mat *T) Trace() float32

Trace returns the trace value for the matrix.

func (*T) TransformVec2

func (mat *T) TransformVec2(v *vec2.T)

TransformVec2 multiplies v with mat and saves the result in v.

func (*T) Transpose

func (mat *T) Transpose() *T

Transpose transposes the matrix.