Difference between revisions of "Canvas:renderTo"

(changed 255 color range to 1)
(Added variant for array, volume, and cube textures)
Line 19: Line 19:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 +
{{param|function|func|A function performing drawing operations.}}
 +
=== Returns ===
 +
Nothing.
 +
 +
== Function ==
 +
=== Synopsis ===
 +
<source lang="lua">
 +
Canvas:renderTo( index, func )
 +
</source>
 +
=== Arguments ===
 +
{{param|number|index|An index to a layer (for array textures and volume textures) or an index to a cubemap face (for cubemap textures).}}
 
{{param|function|func|A function performing drawing operations.}}
 
{{param|function|func|A function performing drawing operations.}}
 
=== Returns ===
 
=== Returns ===

Revision as of 21:54, 30 December 2022

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

Render to the Canvas using a function.

This is a shortcut to love.graphics.setCanvas:

canvas:renderTo( func )

is the same as

love.graphics.setCanvas( canvas )
func()
love.graphics.setCanvas()

Function

Synopsis

Canvas:renderTo( func )

Arguments

function func
A function performing drawing operations.

Returns

Nothing.

Function

Synopsis

Canvas:renderTo( index, func )

Arguments

number index
An index to a layer (for array textures and volume textures) or an index to a cubemap face (for cubemap textures).
function func
A function performing drawing operations.

Returns

Nothing.

Examples

Using an anonymous function for drawing to a Canvas

This example randomly draws a bunch of red lines from the top left corner of the screen to the bottom.

local canvas = love.graphics.newCanvas()
function love.update()
    canvas:renderTo(function()
        love.graphics.setColor(love.math.random(), 0, 0);
        love.graphics.line(0, 0, love.math.random(0, love.graphics.getWidth()), love.math.random(0, love.graphics.getHeight()));
    end);
end

function love.draw()
    love.graphics.setColor(1, 1, 1);
    love.graphics.draw(canvas);
end

See Also

Other Languages