mirror of
https://github.com/godotengine/godot.git
synced 2025-11-01 14:11:15 +00:00
f5836b40d4
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.
(cherry picked from commit 7adf4cc9b5)
76 lines
2.5 KiB
XML
76 lines
2.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="LargeTexture" inherits="Texture" version="3.4">
|
|
<brief_description>
|
|
[i]Deprecated.[/i] A [Texture] capable of storing many smaller textures with offsets.
|
|
</brief_description>
|
|
<description>
|
|
[i]Deprecated (will be removed in Godot 4.0).[/i] A [Texture] capable of storing many smaller textures with offsets.
|
|
You can dynamically add pieces ([Texture]s) to this [LargeTexture] using different offsets.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_piece">
|
|
<return type="int" />
|
|
<argument index="0" name="ofs" type="Vector2" />
|
|
<argument index="1" name="texture" type="Texture" />
|
|
<description>
|
|
Adds [code]texture[/code] to this [LargeTexture], starting on offset [code]ofs[/code].
|
|
</description>
|
|
</method>
|
|
<method name="clear">
|
|
<return type="void" />
|
|
<description>
|
|
Clears the [LargeTexture].
|
|
</description>
|
|
</method>
|
|
<method name="get_piece_count" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the number of pieces currently in this [LargeTexture].
|
|
</description>
|
|
</method>
|
|
<method name="get_piece_offset" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<argument index="0" name="idx" type="int" />
|
|
<description>
|
|
Returns the offset of the piece with the index [code]idx[/code].
|
|
</description>
|
|
</method>
|
|
<method name="get_piece_texture" qualifiers="const">
|
|
<return type="Texture" />
|
|
<argument index="0" name="idx" type="int" />
|
|
<description>
|
|
Returns the [Texture] of the piece with the index [code]idx[/code].
|
|
</description>
|
|
</method>
|
|
<method name="set_piece_offset">
|
|
<return type="void" />
|
|
<argument index="0" name="idx" type="int" />
|
|
<argument index="1" name="ofs" type="Vector2" />
|
|
<description>
|
|
Sets the offset of the piece with the index [code]idx[/code] to [code]ofs[/code].
|
|
</description>
|
|
</method>
|
|
<method name="set_piece_texture">
|
|
<return type="void" />
|
|
<argument index="0" name="idx" type="int" />
|
|
<argument index="1" name="texture" type="Texture" />
|
|
<description>
|
|
Sets the [Texture] of the piece with index [code]idx[/code] to [code]texture[/code].
|
|
</description>
|
|
</method>
|
|
<method name="set_size">
|
|
<return type="void" />
|
|
<argument index="0" name="size" type="Vector2" />
|
|
<description>
|
|
Sets the size of this [LargeTexture].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="flags" type="int" setter="set_flags" getter="get_flags" override="true" default="0" />
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|