Difference between revisions of "love.graphics.newScreenshot"
(Updated for 11.0) |
|||
| (8 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{oldin|[[11.0]]|110|type=function|text=It has been replaced by [[love.graphics.captureScreenshot]]}} | ||
Creates a screenshot and returns the image data. | Creates a screenshot and returns the image data. | ||
| + | {{newobjectnotice}} | ||
| + | |||
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
| Line 8: | Line 11: | ||
None. | None. | ||
=== Returns === | === Returns === | ||
| − | {{param|ImageData|screenshot|The image data of the screenshot}} | + | {{param|ImageData|screenshot|The image data of the screenshot.}} |
| + | |||
| + | == Function == | ||
| + | {{newin|[[0.9.0]]|090|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | screenshot = love.graphics.newScreenshot( copyAlpha ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|boolean|copyAlpha (false)|Whether to include the screen's alpha channel in the ImageData. If false, the screenshot will be fully opaque.}} | ||
| + | === Returns === | ||
| + | {{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('png', os.time() .. '.png'); | ||
| + | end | ||
| + | </source> | ||
| + | |||
== See Also == | == See Also == | ||
* [[parent::love.graphics]] | * [[parent::love.graphics]] | ||
| + | * [[Constructs::ImageData]] | ||
| + | * [[ImageData:encode]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description=Creates a screenshot and returns the | + | {{#set:Description=Creates a screenshot and returns the [[ImageData]].}} |
| + | {{#set:Since=000}} | ||
| + | {{#set:Sub-Category=Object Creation}} | ||
== Other Languages == | == Other Languages == | ||
{{i18n|love.graphics.newScreenshot}} | {{i18n|love.graphics.newScreenshot}} | ||
Latest revision as of 20:11, 1 April 2018
| Removed in LÖVE 11.0 |
| It has been replaced by love.graphics.captureScreenshot. |
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('png', 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
