mirror of
https://github.com/godotengine/godot.git
synced 2024-11-27 09:16:35 +08:00
d516aab8fa
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
97 lines
3.1 KiB
XML
97 lines
3.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ImageTexture" inherits="Texture" category="Core" version="3.0-stable">
|
|
<brief_description>
|
|
A [Texture] based on an [Image].
|
|
</brief_description>
|
|
<description>
|
|
A [Texture] based on an [Image]. Can be created from an [Image] with [method create_from_image].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<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>
|
|
Create a new [code]ImageTexture[/code] with "width" and "height".
|
|
"format" one of [Image].FORMAT_*.
|
|
"flags" one or more of [Texture].FLAG_*.
|
|
</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>
|
|
Create a new [code]ImageTexture[/code] from an [Image] with "flags" from [Texture].FLAG_*.
|
|
</description>
|
|
</method>
|
|
<method name="get_format" qualifiers="const">
|
|
<return type="int" enum="Image.Format">
|
|
</return>
|
|
<description>
|
|
Return the format of the [code]ImageTexture[/code], one of [Image].FORMAT_*.
|
|
</description>
|
|
</method>
|
|
<method name="load">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="path" type="String">
|
|
</argument>
|
|
<description>
|
|
Load an [code]ImageTexture[/code].
|
|
</description>
|
|
</method>
|
|
<method name="set_data">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="image" type="Image">
|
|
</argument>
|
|
<description>
|
|
Set the [Image] of this [code]ImageTexture[/code].
|
|
</description>
|
|
</method>
|
|
<method name="set_size_override">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="size" type="Vector2">
|
|
</argument>
|
|
<description>
|
|
Resizes the [code]ImageTexture[/code] to the specified dimensions.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="lossy_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality">
|
|
The storage quality for [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY.
|
|
</member>
|
|
<member name="storage" type="int" setter="set_storage" getter="get_storage" enum="ImageTexture.Storage">
|
|
The storage type (raw, lossy, or compressed).
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
<constant name="STORAGE_RAW" value="0" enum="Storage">
|
|
[Image] data is stored raw and unaltered.
|
|
</constant>
|
|
<constant name="STORAGE_COMPRESS_LOSSY" value="1" enum="Storage">
|
|
[Image] data is compressed with a lossy algorithm. You can set the storage quality with [method set_lossy_storage_quality].
|
|
</constant>
|
|
<constant name="STORAGE_COMPRESS_LOSSLESS" value="2" enum="Storage">
|
|
[Image] data is compressed with a lossless algorithm.
|
|
</constant>
|
|
</constants>
|
|
</class>
|