Transform:getMatrix

Available since LÖVE 11.0
This function is not supported in earlier versions.

Gets the internal 4x4 transformation matrix stored by this Transform. The matrix is returned in row-major order.

Function

Synopsis

e1_1, e1_2, ..., e4_4 = Transform:getMatrix( )

Arguments

None.

Returns

number e1_1
The first column of the first row of the matrix.
number e1_2
The second column of the first row of the matrix.
number ...
Additional matrix elements.
number e4_4
The fourth column of the fourth row of the matrix.


Examples

Get "Transform:translate" transformations from the matrix:

local function getTranslate(transform)
	-- get the matrix from the transform object
	local matrix = transform:getMatrix()
	-- extract X, Y translation values (4th and 8th elements)
	local translateX, translateY = matrix[4], matrix[8]
	return translateX, translateY
end

Get "Transform:scale" transformations from the matrix:

local function getScale(transform)
	-- get the matrix from the transform object
	local matrix = transform:getMatrix()
	-- extract X, Y scale values
	local scaleX, scaleY = matrix[1], matrix[6]
	return scaleX, scaleY
end

See Also

Other Languages