love.graphics.newImage

Creates a new Image from a filepath, FileData, an ImageData, or a CompressedImageData, and optionally generates or specifies mipmaps for the image.

Version 11.0 updated love.graphics.newImage to treat file names ending with "@2x", "@3x", etc. as a pixel density scale factor if none is explicitly supplied.

This function can be slow if it is called repeatedly, such as from love.update or love.draw. If you need to use a specific resource often, create it once and store it somewhere it can be reused!

Function

Synopsis

image = love.graphics.newImage( filename )

Arguments

string filename

The filepath to the image file.

Returns

Image image

An Image object which can be drawn on screen.

Function

Synopsis

image = love.graphics.newImage( imageData )

Arguments

ImageData imageData

An ImageData object. The Image will use this ImageData to reload itself when love.window.setMode is called.

Returns

Image image

An Image object which can be drawn on screen.

Function

Available since LÖVE 0.9.0
This variant is not supported in earlier versions.

Synopsis

image = love.graphics.newImage( compressedImageData )

Arguments

CompressedImageData compressedImageData

A CompressedImageData object. The Image will use this CompressedImageData to reload itself when love.window.setMode is called.

Returns

Image image

An Image object which can be drawn on screen.

Function

Available since LÖVE 0.10.0
This variant is not supported in earlier versions.

Synopsis

image = love.graphics.newImage( filename, flags )

Arguments

string filename

The filepath to the image file (or a FileData or ImageData or CompressedImageData or ByteData object).

table flags

A table containing the following fields:

boolean linear (false)

True if the image's pixels should be interpreted as being linear RGB rather than sRGB-encoded, if gamma-correct rendering is enabled. Has no effect otherwise.

boolean or table mipmaps (false)

If true, mipmaps for the image will be automatically generated (or taken from the images's file if possible, if the image originated from a CompressedImageData). If this value is a table, it should contain a list of other filenames of images of the same format that have progressively half-sized dimensions, all the way down to 1x1. Those images will be used as this Image's mipmap levels.

Returns

Image image

A new Image object which can be drawn on screen.

Function

Available since LÖVE 0.9.1 and removed in LÖVE 0.10.0
This variant is not supported in earlier or later versions.

Synopsis

image = love.graphics.newImage( filename, format )

Arguments

string filename

The filepath to the image file (or a FileData or ImageData or CompressedImageData object.)

TextureFormat format

The format to interpret the image's data as.

Returns

Image image

An Image object which can be drawn on screen.

Examples

Draw a bunny on the screen

function love.load()
	bunny = love.graphics.newImage("MyBunny.png")
end
function love.draw()
	love.graphics.draw(bunny, 0, 0)
end

See Also

• love.graphics
• Image