Difference between revisions of "love.graphics.getCanvas"

(Created page with "{{newin|0.8.0|080|type=function}} Gets the current target Canvas. == Function == === Synopsis === <source lang="lua"> canvas = love.graphics.getCanvas( ) </source> === Argum...")
 
(Clarified that getCanvas may return more than one canvas.)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{newin|[[0.8.0]]|080|type=function}}
 
{{newin|[[0.8.0]]|080|type=function}}
Gets the current target Canvas.
+
Gets the current target [[Canvas]].
  
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
canvas = love.graphics.getCanvas( )
+
canvas, ... = love.graphics.getCanvas( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|Canvas|canvas|The Canvas set by [[love.graphics.setCanvas|setCanvas]]. Returns nil if drawing to the real screen.}}
+
{{param|Canvas|canvas|The Canvas set by [[love.graphics.setCanvas|setCanvas]]. Returns <code>nil</code> if drawing to the screen.}}
 +
{{param|Canvas|...|Additional canvases if more than one was set.}}
  
 
== See Also ==
 
== See Also ==
Line 18: Line 19:
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Returns the current target Canvas.}}
 
{{#set:Description=Returns the current target Canvas.}}
 
+
{{#set:Since=080}}
 +
{{#set:Sub-Category=State}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.graphics.getCanvas}}
 
{{i18n|love.graphics.getCanvas}}

Latest revision as of 16:21, 28 November 2024

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

Gets the current target Canvas.

Function

Synopsis

canvas, ... = love.graphics.getCanvas( )

Arguments

None.

Returns

Canvas canvas
The Canvas set by setCanvas. Returns nil if drawing to the screen.
Canvas ...
Additional canvases if more than one was set.

See Also


Other Languages