love.graphics.draw

Draw objects on screen. Drawable objects are usually loaded images, but may be other kinds of Drawable objects, such as a ParticleSystem.

In addition to simple drawing, the draw() function can rotate and scale the object at the same time, as well as offset the image (for example, to center the image at the chosen coordinates).

Function

Synopsis

love.graphics.draw( drawable, x, y, r, sx, sy, ox, oy )

Arguments

Drawable drawable

A drawable object.

number x

The position to draw the object (x-axis).

number y

The position to draw the object (y-axis).

number r (0)

Orientation (radians).

number sx (1)

Scale factor (x-axis). Can be negative.

number sy (sx)

Scale factor (y-axis). Can be negative.

number ox (0)

Origin offset (x-axis). (A value of 20 would effectively move your drawable object 20 pixels to the left.)

number oy (0)

Origin offset (y-axis). (A value of 20 would effectively move your drawable object 20 pixels up.)

Returns

Nothing.

Notes

love.graphics.draw() anchors from the top left corner by default.

You can specify a negative value for sx or sy to flip the drawable horizontally or vertically.

The pivotal point is (x, y) on the screen and (ox, oy) in the internal coordinate system of the drawable object, before rotation and scaling. The object is scaled by (sx, sy), then rotated by r around the pivotal point.

The default ColorMode blends the current drawing color into the image, so you will often want to invoke love.graphics.setColorMode("replace") before drawing images, to ensure that the drawn image matches the source image file.

The origin offset values are most often used to shift the images up and left by half of its height and width, so that (effectively) the specified x and y coordinates are where the center of the image will end up.

Examples

Draw an image (the Hamster Ball) at 100 by 100 pixels

function love.load()
   hamster = love.graphics.newImage("hamster.png")
end
function love.draw()
   love.graphics.draw(hamster, 100, 100)
end

Draw an image (the Hamster Ball) from the center at 100 by 100 pixels, rotated by 90 degrees

function love.load()
   hamster = love.graphics.newImage("hamster.png")
   width = hamster:getWidth()
   height = hamster:getHeight()
end
function love.draw()
   love.graphics.draw(hamster, 100, 100, math.rad(90), 1, 1, width / 2, height / 2)
end

See Also

• love.graphics

Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info