Difference between revisions of "love.graphics.newFramebuffer"

(Created page with '''Functionality added in LÖVE 0.7.0'' Creates a new framebuffer object for offscreen rendering. == Function == === Synopsis === <source lang="lua"> framebuffer = love.graphics…')
 
m (Fixed absolute link.)
 
(23 intermediate revisions by 8 users not shown)
Line 1: Line 1:
''Functionality added in LÖVE 0.7.0''
+
{{newinoldin|[[0.7.0]]|070|[[0.8.0]]|080|type=function|text=It has been renamed to [[love.graphics.newCanvas]]}}
 
 
 
Creates a new framebuffer object for offscreen rendering.
 
Creates a new framebuffer object for offscreen rendering.
 
+
{{notice|Versions prior to 0.8.0 have Framebuffers that are susceptible to [[PO2_Syndrome|power of 2 syndrome]].}}
 +
{{newobjectnotice}}
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 8: Line 8:
 
framebuffer = love.graphics.newFramebuffer( )
 
framebuffer = love.graphics.newFramebuffer( )
 
</source>
 
</source>
 +
=== Arguments ===
 +
None.
 
=== Returns ===
 
=== Returns ===
{{param|Framebuffer|framebuffer|A new framebuffer with width/height equal to the window width/height}}
+
{{param|Framebuffer|framebuffer|A new framebuffer with width/height equal to the window width/height.}}
 +
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 17: Line 20:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|number|width|The desired width of the framebuffer.}}
 
{{param|number|width|The desired width of the framebuffer.}}
{{param|number|height|The desired width of the framebuffer.}}
+
{{param|number|height|The desired height of the framebuffer.}}
 
=== Returns ===
 
=== Returns ===
{{param|Framebuffer|framebuffer|A new framebuffer with specified with and height. Note specifying a size different from the window size will not resize the canvas but the image itself.}}
+
{{param|Framebuffer|framebuffer|A new framebuffer with specified width and height.}}
  
 
== See Also ==
 
== See Also ==
 
* [[parent::love.graphics]]
 
* [[parent::love.graphics]]
 
* [[Constructs::Framebuffer]]
 
* [[Constructs::Framebuffer]]
 +
* [[love.graphics.setRenderTarget]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Creates a new Framebuffer
+
[[Sub-Category::Object Creation| ]]
}}
+
{{#set:Description=Creates a new [[Framebuffer]].}}
 +
== Other Languages ==
 +
{{i18n|love.graphics.newFramebuffer}}

Latest revision as of 03:53, 6 September 2016

Available since LÖVE 0.7.0 and removed in LÖVE 0.8.0
It has been renamed to love.graphics.newCanvas.

Creates a new framebuffer object for offscreen rendering.

O.png Versions prior to 0.8.0 have Framebuffers that are susceptible to power of 2 syndrome.  


O.png 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

framebuffer = love.graphics.newFramebuffer( )

Arguments

None.

Returns

Framebuffer framebuffer
A new framebuffer with width/height equal to the window width/height.

Function

Synopsis

framebuffer = love.graphics.newFramebuffer( width, height )

Arguments

number width
The desired width of the framebuffer.
number height
The desired height of the framebuffer.

Returns

Framebuffer framebuffer
A new framebuffer with specified width and height.

See Also


Other Languages