Difference between revisions of "love.graphics.newImage"
(→Arguments) |
|||
(25 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
− | + | Creates a new [[Image]] from a filepath, [[FileData]], an [[ImageData]], or a [[CompressedImageData]], and optionally generates or specifies mipmaps for the image. | |
− | Creates a new [[Image]] from a filepath | + | {{newobjectnotice}} |
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
Line 10: | Line 10: | ||
=== Returns === | === Returns === | ||
{{param|Image|image|An Image object which can be drawn on screen.}} | {{param|Image|image|An Image object which can be drawn on screen.}} | ||
+ | |||
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
− | image = love.graphics.newImage( | + | image = love.graphics.newImage( imageData ) |
+ | </source> | ||
+ | === Arguments === | ||
+ | {{param|ImageData|imageData|An ImageData object. The Image will use this ImageData to reload itself when [[love.window.setMode]] is called.}} | ||
+ | === Returns === | ||
+ | {{param|Image|image|An Image object which can be drawn on screen.}} | ||
+ | |||
+ | == Function == | ||
+ | {{newin|[[0.9.0]]|090|type=variant}} | ||
+ | === Synopsis === | ||
+ | <source lang="lua"> | ||
+ | image = love.graphics.newImage( compressedImageData ) | ||
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
− | {{param| | + | {{param|CompressedImageData|compressedImageData|A CompressedImageData object. The Image will use this CompressedImageData to reload itself when [[love.window.setMode]] is called.}} |
=== Returns === | === Returns === | ||
{{param|Image|image|An Image object which can be drawn on screen.}} | {{param|Image|image|An Image object which can be drawn on screen.}} | ||
+ | |||
== Function == | == Function == | ||
+ | {{newin|[[0.10.0]]|100|type=variant}} | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
− | image = love.graphics.newImage( | + | image = love.graphics.newImage( filename, flags ) |
+ | </source> | ||
+ | === Arguments === | ||
+ | {{param|string|filename|The filepath to the image file (or a [[FileData]] or [[ImageData]] or [[CompressedImageData]] or [[ByteData]] object).}} | ||
+ | {{param|table|flags|A table containing the following fields:}} | ||
+ | {{subparam|boolean|linear (false)|True if the image's pixels should be interpreted as being linear RGB rather than sRGB-encoded, if [[love.graphics.isGammaCorrect|gamma-correct rendering]] is enabled. Has no effect otherwise.}} | ||
+ | {{subparam|boolean or table|mipmaps (false)|If true, mipmaps for the image will be automatically generated (or taken from the images's file if possible, if the image originated from a [[CompressedImageData]]). If this value is a table, it should contain a list of other filenames of images of the same format that have progressively half-sized dimensions, all the way down to 1x1. Those images will be used as this Image's mipmap levels.}} | ||
+ | |||
+ | === Returns === | ||
+ | {{param|Image|image|A new Image object which can be drawn on screen.}} | ||
+ | |||
+ | == Function == | ||
+ | {{newinoldin|[[0.9.1]]|091|[[0.10.0]]|100|type=variant}} | ||
+ | === Synopsis === | ||
+ | <source lang="lua"> | ||
+ | image = love.graphics.newImage( filename, format ) | ||
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
− | {{param| | + | {{param|string|filename|The filepath to the image file (or a [[FileData]] or [[ImageData]] or [[CompressedImageData]] object.)}} |
+ | {{param|TextureFormat|format|The format to interpret the image's data as.}} | ||
=== Returns === | === Returns === | ||
{{param|Image|image|An Image object which can be drawn on screen.}} | {{param|Image|image|An Image object which can be drawn on screen.}} | ||
+ | |||
== See Also == | == See Also == | ||
* [[parent::love.graphics]] | * [[parent::love.graphics]] | ||
+ | * [[Constructs::Image]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
− | {{#set:Description=Creates a new Image | + | [[Sub-Category::Object Creation| ]] |
+ | {{#set:Description=Creates a new [[Image]].}} | ||
+ | {{#set:Since=000}} | ||
+ | == Other Languages == | ||
+ | {{i18n|love.graphics.newImage}} |
Revision as of 14:39, 30 December 2019
Creates a new Image from a filepath, FileData, an ImageData, or a CompressedImageData, and optionally generates or specifies mipmaps for the image.
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
image = love.graphics.newImage( filename )
Arguments
string filename
- The filepath to the image file.
Returns
Image image
- An Image object which can be drawn on screen.
Function
Synopsis
image = love.graphics.newImage( imageData )
Arguments
ImageData imageData
- An ImageData object. The Image will use this ImageData to reload itself when love.window.setMode is called.
Returns
Image image
- An Image object which can be drawn on screen.
Function
Available since LÖVE 0.9.0 |
This variant is not supported in earlier versions. |
Synopsis
image = love.graphics.newImage( compressedImageData )
Arguments
CompressedImageData compressedImageData
- A CompressedImageData object. The Image will use this CompressedImageData to reload itself when love.window.setMode is called.
Returns
Image image
- An Image object which can be drawn on screen.
Function
Available since LÖVE 0.10.0 |
This variant is not supported in earlier versions. |
Synopsis
image = love.graphics.newImage( filename, flags )
Arguments
string filename
- The filepath to the image file (or a FileData or ImageData or CompressedImageData or ByteData object).
table flags
- A table containing the following fields:
boolean linear (false)
- True if the image's pixels should be interpreted as being linear RGB rather than sRGB-encoded, if gamma-correct rendering is enabled. Has no effect otherwise.
boolean or table mipmaps (false)
- If true, mipmaps for the image will be automatically generated (or taken from the images's file if possible, if the image originated from a CompressedImageData). If this value is a table, it should contain a list of other filenames of images of the same format that have progressively half-sized dimensions, all the way down to 1x1. Those images will be used as this Image's mipmap levels.
Returns
Image image
- A new Image object which can be drawn on screen.
Function
Available since LÖVE 0.9.1 and removed in LÖVE 0.10.0 |
This variant is not supported in earlier or later versions. |
Synopsis
image = love.graphics.newImage( filename, format )
Arguments
string filename
- The filepath to the image file (or a FileData or ImageData or CompressedImageData object.)
TextureFormat format
- The format to interpret the image's data as.
Returns
Image image
- An Image object which can be drawn on screen.
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