Difference between revisions of "love.graphics.newScreenshot"
(Added new 0.9.0 variant) |
(Add example.) |
||
Line 22: | Line 22: | ||
=== Returns === | === Returns === | ||
{{param|ImageData|screenshot|The image data of the screenshot.}} | {{param|ImageData|screenshot|The image data of the screenshot.}} | ||
+ | |||
+ | == Examples == | ||
+ | Create a new screenshot and write it to the save directory. | ||
+ | <source lang="lua"> | ||
+ | function love.load() | ||
+ | love.filesystem.setIdentity('screenshot_example'); | ||
+ | end | ||
+ | |||
+ | function love.keypressed() | ||
+ | local screenshot = love.graphics.newScreenshot(); | ||
+ | screenshot:encode(os.time() .. '.png'); | ||
+ | end | ||
+ | </source> | ||
== See Also == | == See Also == |
Revision as of 23:55, 22 February 2015
Creates a screenshot and returns the image data.
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! |
Contents
Function
Synopsis
screenshot = love.graphics.newScreenshot( )
Arguments
None.
Returns
ImageData screenshot
- The image data of the screenshot.
Function
Available since LÖVE 0.9.0 |
This variant is not supported in earlier versions. |
Synopsis
screenshot = love.graphics.newScreenshot( copyAlpha )
Arguments
boolean copyAlpha (false)
- Whether to include the screen's alpha channel in the ImageData. If false, the screenshot will be fully opaque.
Returns
ImageData screenshot
- The image data of the screenshot.
Examples
Create a new screenshot and write it to the save directory.
function love.load()
love.filesystem.setIdentity('screenshot_example');
end
function love.keypressed()
local screenshot = love.graphics.newScreenshot();
screenshot:encode(os.time() .. '.png');
end
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info