Canvas

O.png Some older graphics cards do not support canvases, and will throw an error if you attempt to use them. You should try to avoid using canvases unless you can not achieve the desired effect without them, to avoid excluding users.  

Available since LÖVE 0.8.0
It has been renamed from Framebuffer.


A Canvas is used for off-screen rendering. Think of it as an invisible screen that you can draw to, but that will not be visible until you draw it to the actual visible screen. It is also known as "render to texture".

By drawing things that do not change position often (such as background items) to the Canvas, and then drawing the entire Canvas instead of each item, you can reduce the number of draw operations performed each frame.

Canvases can be susceptible to power of 2 syndrome. Most graphics cards that support Canvas should have non-PO2 texture support. However, there are some old cards that do not. Check with love.graphics.isSupported("npot") if it is supported.

Constructors

love.graphics.newCanvas Creates a new Canvas.

Functions

Canvas:clear Clears content of a Canvas.
Canvas:getFilter Gets the filter mode of the Canvas.
Canvas:getImageData Get stored ImageData.
Canvas:getWrap Gets the wrapping properties of a Canvas.
Canvas:renderTo Render to a Canvas using a function.
Canvas:setFilter Sets the filter mode of the Canvas.
Canvas:setWrap Sets the wrapping properties of a Canvas.
Object:type Gets the type of the object as a string.
Object:typeOf Checks whether an object is of a certain type.

Supertypes

Examples

sample from the forum

http://love2d.org/forums/viewtopic.php?f=4&t=2136&start=20

See Also


Other Languages

Personal tools