glm_api.md

glm module API

The following classes are exposed to the Lua API:

• vec3
• vec4
• mat3
• mat4

Along with the following functions:

• cross
• dot
• normalize
• column
• row
• inverse
• transpose
• column
• row
• inverse
• transpose

Class Reference:

vec3

A three-component vector of type float.

Class Members:

float x

float y

float z

Class Methods:

vec3(float x, float y, float z) -> vec3

Construct a vec3 with components x, y, and z.

vec3(float s) -> vec3

Construct a vec3 with components all its components initialized to s.

vec3(vec3 v) -> vec3

Copy construct a vec3 from the vector v.

vec3 + vec3 -> vec3

Addition between vectors.

vec3 - vec3 -> vec3

Subtraction between vectors.

vec3 * vec3 -> vec3

Component-wise multiplication between vectors.

vec3 + float -> vec3, float + vec3 -> vec3

Addition between a vec3 and a float. Is equivalent to vec3 + vec3(float), vec3(float) + vec3 respectively.

vec3 - float -> vec3, float - vec3 -> vec3

Subtraction between a vec3 and a float. Is equivalent to vec3 - vec3(float), vec3(float) - vec3 respectively.

vec3 * float -> vec3, float * vec3 -> vec3

Multiplication between a vec3 and a float. Is equivalent to vec3 * vec3(float), vec3(float) * vec3 respectively.

vec4

A four-component vector of type float.

Class Members:

float x

float y

float z

float w

Class Methods:

vec4(float x, float y, float z, float w) -> vec4

Construct a vec4 with components x, y, z, and w.

vec4(float s) -> vec4

Construct a vec4 with components all its components initialized to s.

vec4(vec4 v) -> vec4

Copy construct a vec4 from the vector v.

vec4 + vec4 -> vec4

Addition between vectors.

vec4 - vec4 -> vec4

Subtraction between vectors.

vec4 * vec4 -> vec4

Multiplication between vectors.

vec4 + float -> vec4, float + vec4 -> vec4

Addition between a vec4 and a float. Is equivalent to vec4 + vec4(float), vec4(float) + vec4 respectively.

vec4 - float -> vec4, float - vec4 -> vec4

Subtraction between a vec4 and a float. Is equivalent to vec4 - vec4(float), vec4(float) - vec4 respectively.

vec4 * float -> vec4, float * vec4 -> vec4

Multiplication between a vec4 and a float. Is equivalent to vec4 * vec4(float), vec4(float) * vec4 respectively.

mat3

A 3x3 matrix of type float. The elements are stored in column-major order.

Class Methods:

mat3(float s) -> mat3

Construct a mat3 with components all its components initialized to s.

mat3(mat3 m) -> mat3

Copy construct a mat3 from the vector m.

mat3(mat4 m) -> mat3

Construct a mat3 from the upper left 3x3 part of mat4.

mat3 + mat3 -> mat3

Matrix addition.

mat3 - mat3 -> mat3

Matrix subtraction.

mat3 * mat3 -> mat3

Matrix multiplication.

mat3 * vec3 -> vec3

Matrix vector multiplication.

mat3 + float -> mat3, float + mat3 -> mat3

Addition between a mat3 and a float. Is equivalent to mat3 + mat3(float), mat3(float) + mat3 respectively.

mat3 - float -> mat3, float - mat3 -> mat3

Subtraction between a mat3 and a float. Is equivalent to mat3 - mat3(float), mat3(float) - mat3 respectively.

mat3 * float -> mat3, float * mat3 -> mat3

Multiplication between a mat3 and a float. Is equivalent to mat3 * mat3(float), mat3(float) * mat3 respectively.

mat4

A 4x4 matrix of type float. The elements are stored in column-major order.

Function Reference:

cross(vec3 va, vec3 vb) -> mat3

Vector cross product between vectors va and vb.

dot(vec3 va, vec3 vb) -> float

Dot product between vectors va and vb.

normalize(vec3 v) -> vec3

Returns the vector v normalized by its length.

column(mat3 m, int i) -> vec3

Returns the column i of the mat3 matrix m.

row(mat3 m, int i) -> vec3

Returns the row i of the mat3 matrix m.

inverse(mat3 m) -> mat3

Returns the inverse of the mat3 matrix m.

transpose(mat3 m) -> mat3

Returns the transpose of the mat3 matrix m.

column(mat4 m, int i) -> vec4

Returns the column i of the mat4 matrix m.

row(mat4 m, int i) -> vec4

Returns the row i of the mat4 matrix m.

inverse(mat4 m) -> mat4

Returns the inverse of the mat4 matrix m.

transpose(mat4 m) -> mat4

Returns the transpose of the mat4 matrix m.