2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 11:32:53 +02:00
<class name= "ImageTexture" inherits= "Texture" category= "Core" version= "3.1.2" >
2017-09-12 22:42:36 +02:00
<brief_description >
A [Texture] based on an [Image].
</brief_description>
<description >
2017-10-09 12:49:12 +02:00
A [Texture] based on an [Image]. Can be created from an [Image] with [method create_from_image].
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "create" >
<return type= "void" >
</return>
<argument index= "0" name= "width" type= "int" >
</argument>
<argument index= "1" name= "height" type= "int" >
</argument>
<argument index= "2" name= "format" type= "int" enum= "Image.Format" >
</argument>
<argument index= "3" name= "flags" type= "int" default= "7" >
</argument>
<description >
2018-12-29 00:17:09 +01:00
Create a new [code]ImageTexture[/code] with [code]width[/code] and [code]height[/code].
[code]format[/code] is a value from [enum Image.Format], [code]flags[/code] is any combination of [enum Texture.Flags].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "create_from_image" >
<return type= "void" >
</return>
<argument index= "0" name= "image" type= "Image" >
</argument>
<argument index= "1" name= "flags" type= "int" default= "7" >
</argument>
<description >
2018-12-29 00:17:09 +01:00
Create a new [code]ImageTexture[/code] from an [Image] with [code]flags[/code] from [enum Texture.Flags]. An sRGB to linear color space conversion can take place, according to [enum Image.Format].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_format" qualifiers= "const" >
<return type= "int" enum= "Image.Format" >
</return>
<description >
2018-12-29 00:17:09 +01:00
Return the format of the [code]ImageTexture[/code], one of [enum Image.Format].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "load" >
2018-05-12 16:53:45 +02:00
<return type= "int" enum= "Error" >
2017-09-12 22:42:36 +02:00
</return>
<argument index= "0" name= "path" type= "String" >
</argument>
<description >
2018-05-12 16:53:45 +02:00
Load an [code]ImageTexture[/code] from a file path.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_data" >
<return type= "void" >
</return>
<argument index= "0" name= "image" type= "Image" >
</argument>
<description >
2017-10-22 12:56:11 +02:00
Set the [Image] of this [code]ImageTexture[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_size_override" >
<return type= "void" >
</return>
<argument index= "0" name= "size" type= "Vector2" >
</argument>
<description >
2017-10-09 12:49:12 +02:00
Resizes the [code]ImageTexture[/code] to the specified dimensions.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
2018-01-11 23:38:35 +01:00
<members >
<member name= "lossy_quality" type= "float" setter= "set_lossy_storage_quality" getter= "get_lossy_storage_quality" >
2018-12-29 00:17:09 +01:00
The storage quality for [code]STORAGE_COMPRESS_LOSSY[/code].
2018-01-11 23:38:35 +01:00
</member>
<member name= "storage" type= "int" setter= "set_storage" getter= "get_storage" enum= "ImageTexture.Storage" >
The storage type (raw, lossy, or compressed).
</member>
</members>
2017-09-12 22:42:36 +02:00
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "STORAGE_RAW" value= "0" enum= "Storage" >
2017-09-12 22:42:36 +02:00
[Image] data is stored raw and unaltered.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "STORAGE_COMPRESS_LOSSY" value= "1" enum= "Storage" >
2018-12-29 00:17:09 +01:00
[Image] data is compressed with a lossy algorithm. You can set the storage quality with [member lossy_quality].
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "STORAGE_COMPRESS_LOSSLESS" value= "2" enum= "Storage" >
2017-09-12 22:42:36 +02:00
[Image] data is compressed with a lossless algorithm.
</constant>
</constants>
</class>