GLKMatrix3 Reference

Overview

The GKLMatrix3 type defines a 3x3 floating-point matrix as well as many mathematical operations commonly used to manipulate matrices. A 3x3 matrix is commonly used in graphics programming to represent scaling or rotation transformations to convert from one coordinate system to another.

The functions that manipulate GKLMatrix3 structures treat the inputs as immutable, instead returning a new matrix that represent the results of the operation.

Functions by Task

Creating Matrices

• GLKMatrix3Make
• GLKMatrix3MakeAndTranspose
• GLKMatrix3MakeWithArray
• GLKMatrix3MakeWithArrayAndTranspose
• GLKMatrix3MakeWithColumns
• GLKMatrix3MakeWithRows
• GLKMatrix3MakeRotation
• GLKMatrix3MakeXRotation
• GLKMatrix3MakeYRotation
• GLKMatrix3MakeZRotation
• GLKMatrix3MakeWithQuaternion
• GLKMatrix3MakeScale

Working With Parts of a Matrix

• GLKMatrix3GetMatrix2
• GLKMatrix3GetColumn
• GLKMatrix3GetRow
• GLKMatrix3SetColumn
• GLKMatrix3SetRow

Performing Mathematical Operations on Matrices

• GLKMatrix3Invert
• GLKMatrix3Transpose
• GLKMatrix3InvertAndTranspose
• GLKMatrix3Multiply
• GLKMatrix3Rotate
• GLKMatrix3RotateWithVector3
• GLKMatrix3RotateWithVector4
• GLKMatrix3RotateX
• GLKMatrix3RotateY
• GLKMatrix3RotateZ
• GLKMatrix3Scale
• GLKMatrix3ScaleWithVector3
• GLKMatrix3ScaleWithVector4
• GLKMatrix3Add
• GLKMatrix3Subtract

Performing Mathematical Operations on Vectors

• GLKMatrix3MultiplyVector3
• GLKMatrix3MultiplyVector3Array

Functions

GLKMatrix3Add

Returns a new 3x3 matrix created by performing a component-wise addition of two matrices.

GLKMatrix3 GLKMatrix3Add (
   GLKMatrix3 matrixLeft,
   GLKMatrix3 matrixRight
);

GLKMatrix3GetColumn

Retrieves a column from a 3x3 matrix.

GLKVector3 GLKMatrix3GetColumn (
   GLKMatrix3 matrix,
   int column
);

GLKMatrix3GetMatrix2

Returns the upper-left 2x2 section of a 3x3 matrix.

GLKMatrix2 GLKMatrix3GetMatrix2 (
   GLKMatrix3 matrix
);

GLKMatrix3GetRow

Retrieves a row from a 3x3 matrix.

GLKVector3 GLKMatrix3GetRow (
   GLKMatrix3 matrix,
   int row
);

GLKMatrix3Invert

Returns the inverse of a matrix.

GLKMatrix3 GLKMatrix3Invert (
   GLKMatrix3 matrix,
   bool *isInvertible
);

GLKMatrix3InvertAndTranspose

Returns the inverse transpose of a matrix.

GLKMatrix3 GLKMatrix3InvertAndTranspose (
   GLKMatrix3 matrix,
   bool *isInvertible
);

GLKMatrix3Make

Returns a 3x3 matrix created from individual component values.

GLKMatrix3 GLKMatrix3Make (
   float m00,
   float m01,
   float m02,
   float m10,
   float m11,
   float m12,
   float m20,
   float m21,
   float m22
);

GLKMatrix3MakeAndTranspose

Returns a 3x3 transposed matrix created from individual component values.

GLKMatrix3 GLKMatrix3MakeAndTranspose (
   float m00,
   float m01,
   float m02,
   float m10,
   float m11,
   float m12,
   float m20,
   float m21,
   float m22
);

GLKMatrix3MakeRotation

Returns a 3x3 matrix that performs a rotation around an arbitrary vector.

GLKMatrix3 GLKMatrix3MakeRotation (
   float radians,
   float x,
   float y,
   float z
);

GLKMatrix3MakeScale

Returns a 3x3 matrix that performs a scaling transformation.

GLKMatrix3 GLKMatrix3MakeScale (
   float sx,
   float sy,
   float sz
);

GLKMatrix3MakeWithArray

Returns a 3x3 matrix created from an array of component values.

GLKMatrix3 GLKMatrix3MakeWithArray (
   float values[9]
);

GLKMatrix3MakeWithArrayAndTranspose

Returns a 3x3 transposed matrix created from an array of component values.

GLKMatrix3 GLKMatrix3MakeWithArrayAndTranspose (
   float values[9]
);

GLKMatrix3MakeWithColumns

Returns a 3x3 matrix created from three column vectors.

GLKMatrix3 GLKMatrix3MakeWithColumns (
   GLKVector3 column0,
   GLKVector3 column1,
   GLKVector3 column2
);

GLKMatrix3MakeWithQuaternion

Returns a 3x3 matrix that performs a rotation based on a quaternion.

GLKMatrix3 GLKMatrix3MakeWithQuaternion (
   GLKQuaternion quaternion
);

GLKMatrix3MakeWithRows

Returns a 3x3 matrix created from three row vectors.

GLKMatrix3 GLKMatrix3MakeWithRows (
   GLKVector3 row0,
   GLKVector3 row1,
   GLKVector3 row2
);

GLKMatrix3MakeXRotation

Returns a 3x3 matrix that performs a rotation around the positive x-axis.

GLKMatrix3 GLKMatrix3MakeXRotation (
   float radians
);

GLKMatrix3MakeYRotation

Returns a 3x3 matrix that performs a rotation around the positive y-axis.

GLKMatrix3 GLKMatrix3MakeYRotation (
   float radians
);

GLKMatrix3MakeZRotation

Returns a 3x3 matrix that performs a rotation around the positive z-axis.

GLKMatrix3 GLKMatrix3MakeZRotation (
   float radians
);

GLKMatrix3Multiply

Returns the product of two matrices.

GLKMatrix3 GLKMatrix3Multiply (
   GLKMatrix3 matrixLeft,
   GLKMatrix3 matrixRight
);

GLKMatrix3MultiplyVector3

Multiplies a 3x3 matrix by a vector.

GLKVector3 GLKMatrix3MultiplyVector3 (
   GLKMatrix3 matrixLeft,
   GLKVector3 vectorRight
);

GLKMatrix3MultiplyVector3Array

Multiplies a 3x3 matrix by an array of vectors.

void GLKMatrix3MultiplyVector3Array (
   GLKMatrix3 matrix,
   GLKVector3 *vectors,
   size_t vectorCount
);

GLKMatrix3Rotate

Returns a new 3x3 matrix created by concatenating a matrix with a rotation around a vector.

GLKMatrix3 GLKMatrix3Rotate (
   GLKMatrix3 matrix,
   float radians,
   float x,
   float y,
   float z
);

GLKMatrix3RotateWithVector3

Returns a new 3x3 matrix created by concatenating a matrix with a rotation around a vector.

GLKMatrix3 GLKMatrix3RotateWithVector3 (
   GLKMatrix3 matrix,
   float radians,
   GLKVector3 axisVector
);

GLKMatrix3RotateWithVector4

Returns a new 3x3 matrix created by concatenating a matrix with a rotation around a vector.

GLKMatrix3 GLKMatrix3RotateWithVector4 (
   GLKMatrix3 matrix,
   float radians,
   GLKVector4 axisVector
);

GLKMatrix3RotateX

Returns a new 3x3 matrix created by concatenating a matrix with a rotation around the x-axis.

GLKMatrix3 GLKMatrix3RotateX (
   GLKMatrix3 matrix,
   float radians
);

GLKMatrix3RotateY

Returns a new 3x3 matrix created by concatenating a matrix with a rotation around the y-axis.

GLKMatrix3 GLKMatrix3RotateY (
   GLKMatrix3 matrix,
   float radians
);

GLKMatrix3RotateZ

Returns a new 3x3 matrix created by concatenating a matrix with a rotation around the z-axis.

GLKMatrix3 GLKMatrix3RotateZ (
   GLKMatrix3 matrix,
   float radians
);

GLKMatrix3Scale

Returns a new 3x3 matrix created by concatenating a matrix with a scaling transform.

GLKMatrix3 GLKMatrix3Scale (
   GLKMatrix3 matrix,
   float sx,
   float sy,
   float sz
);

GLKMatrix3ScaleWithVector3

Returns a new 3x3 matrix created by concatenating a matrix with a scaling transform defined by a vector.

GLKMatrix3 GLKMatrix3ScaleWithVector3 (
   GLKMatrix3 matrix,
   GLKVector3 scaleVector
);

GLKMatrix3ScaleWithVector4

Returns a new 3x3 matrix created by concatenating a matrix with a scaling transform defined by a vector.

GLKMatrix3 GLKMatrix3ScaleWithVector4 (
   GLKMatrix3 matrix,
   GLKVector4 scaleVector
);

GLKMatrix3SetColumn

Returns a new 3x3 matrix with one column replaced by a new vector.

GLKMatrix3 GLKMatrix3SetColumn (
   GLKMatrix3 matrix,
   int column,
   GLKVector3 vector
);

GLKMatrix3SetRow

Returns a new 3x3 matrix with one row replaced by a new vector.

GLKMatrix3 GLKMatrix3SetRow (
   GLKMatrix3 matrix,
   int row,
   GLKVector3 vector
);

GLKMatrix3Subtract

Returns a new 3x3 matrix created by performing a component-wise subtraction of two matrices.

GLKMatrix3 GLKMatrix3Subtract (
   GLKMatrix3 matrixLeft,
   GLKMatrix3 matrixRight
);

GLKMatrix3Transpose

Returns the transpose of a matrix.

GLKMatrix3 GLKMatrix3Transpose (
   GLKMatrix3 matrix
);

Data Types

GLKMatrix2

A 2x2 matrix.

union _GLKMatrix2
   {
      struct
      {
      float m00, m01;
      float m10, m11;
};
   float m2[2][2];
   float m[4];
};
typedef union _GLKMatrix2 GLKMatrix2;

Fields

m00

The [0,0] element of the matrix.

m01

The [0,1] element of the matrix.

m10

The [1,0] element of the matrix.

m11

The [1,1] element of the matrix.

m2

A two-dimensional array of the matrix's elements in column-major order.

m

A one-dimensional array of the matrix’s elements in column-major order.

GLKMatrix3

A 3x3 matrix stored in column-major order.

union _GLKMatrix3
   {
      struct
      {
      float m00, m01, m02;
      float m10, m11, m12;
      float m20, m21, m22;
};
   float m[9];
};
typedef union _GLKMatrix3 GLKMatrix3;

Fields

m00

The [0,0] element of the matrix.

m01

The [0,1] element of the matrix.

m02

The [0,2] element of the matrix.

m10

The [1,0] element of the matrix.

m11

The [1,1] element of the matrix.

m12

The [1,2] element of the matrix.

m20

The [2,0] element of the matrix.

m21

The [2,1] element of the matrix.

m22

The [2,2] element of the matrix.

m

A one-dimensional array of the matrix’s elements in column-major order.

Constants

GLKMatrix3Identity

A 3x3 identity matrix.

extern const GLKMatrix3 GLKMatrix3Identity;

Constants

GLKMatrix3Identity

A 3x3 identity matrix.

Available in iOS 5.0 and later.

Declared in GLKMatrix3.h.