7adf4cc9b5
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
66 lines
3.5 KiB
XML
66 lines
3.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
||
<class name="ImageTexture" inherits="Texture2D" version="4.0">
|
||
<brief_description>
|
||
A [Texture2D] based on an [Image].
|
||
</brief_description>
|
||
<description>
|
||
A [Texture2D] based on an [Image]. For an image to be displayed, an [ImageTexture] has to be created from it using the [method create_from_image] method:
|
||
[codeblock]
|
||
var texture = ImageTexture.new()
|
||
var image = Image.new()
|
||
image.load("res://icon.png")
|
||
texture.create_from_image(image)
|
||
$Sprite2D.texture = texture
|
||
[/codeblock]
|
||
This way, textures can be created at run-time by loading images both from within the editor and externally.
|
||
[b]Warning:[/b] Prefer to load imported textures with [method @GDScript.load] over loading them from within the filesystem dynamically with [method Image.load], as it may not work in exported projects:
|
||
[codeblock]
|
||
var texture = load("res://icon.png")
|
||
$Sprite2D.texture = texture
|
||
[/codeblock]
|
||
This is because images have to be imported as a [StreamTexture2D] first to be loaded with [method @GDScript.load]. If you'd still like to load an image file just like any other [Resource], import it as an [Image] resource instead, and then load it normally using the [method @GDScript.load] method.
|
||
[b]Note:[/b] The image can be retrieved from an imported texture using the [method Texture2D.get_image] method, which returns a copy of the image:
|
||
[codeblock]
|
||
var texture = load("res://icon.png")
|
||
var image : Image = texture.get_image()
|
||
[/codeblock]
|
||
An [ImageTexture] is not meant to be operated from within the editor interface directly, and is mostly useful for rendering images on screen dynamically via code. If you need to generate images procedurally from within the editor, consider saving and importing images as custom texture resources implementing a new [EditorImportPlugin].
|
||
[b]Note:[/b] The maximum texture size is 16384×16384 pixels due to graphics hardware limitations.
|
||
</description>
|
||
<tutorials>
|
||
<link title="Importing images">https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/importing_images.html</link>
|
||
</tutorials>
|
||
<methods>
|
||
<method name="create_from_image">
|
||
<return type="void" />
|
||
<argument index="0" name="image" type="Image" />
|
||
<description>
|
||
Initializes the texture by allocating and setting the data from an [Image].
|
||
</description>
|
||
</method>
|
||
<method name="get_format" qualifiers="const">
|
||
<return type="int" enum="Image.Format" />
|
||
<description>
|
||
Returns the format of the texture, one of [enum Image.Format].
|
||
</description>
|
||
</method>
|
||
<method name="set_size_override">
|
||
<return type="void" />
|
||
<argument index="0" name="size" type="Vector2" />
|
||
<description>
|
||
Resizes the texture to the specified dimensions.
|
||
</description>
|
||
</method>
|
||
<method name="update">
|
||
<return type="void" />
|
||
<argument index="0" name="image" type="Image" />
|
||
<description>
|
||
Replaces the texture's data with a new [Image].
|
||
[b]Note:[/b] The texture has to be initialized first with the [method create_from_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration, otherwise it has to be re-created with the [method create_from_image] method.
|
||
Use this method over [method create_from_image] if you need to update the texture frequently, which is faster than allocating additional memory for a new texture each time.
|
||
</description>
|
||
</method>
|
||
</methods>
|
||
<constants>
|
||
</constants>
|
||
</class>
|