f7f6115f76
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
90 lines
2.6 KiB
XML
90 lines
2.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="LargeTexture" inherits="Texture" category="Core" version="3.2">
|
|
<brief_description>
|
|
A [Texture] capable of storing many smaller textures with offsets.
|
|
</brief_description>
|
|
<description>
|
|
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">
|
|
</return>
|
|
<argument index="0" name="ofs" type="Vector2">
|
|
</argument>
|
|
<argument index="1" name="texture" type="Texture">
|
|
</argument>
|
|
<description>
|
|
Adds [code]texture[/code] to this [LargeTexture], starting on offset [code]ofs[/code].
|
|
</description>
|
|
</method>
|
|
<method name="clear">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Clears the [LargeTexture].
|
|
</description>
|
|
</method>
|
|
<method name="get_piece_count" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
Returns the number of pieces currently in this [LargeTexture].
|
|
</description>
|
|
</method>
|
|
<method name="get_piece_offset" qualifiers="const">
|
|
<return type="Vector2">
|
|
</return>
|
|
<argument index="0" name="idx" type="int">
|
|
</argument>
|
|
<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">
|
|
</return>
|
|
<argument index="0" name="idx" type="int">
|
|
</argument>
|
|
<description>
|
|
Returns the [Texture] of the piece with the index [code]idx[/code].
|
|
</description>
|
|
</method>
|
|
<method name="set_piece_offset">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="idx" type="int">
|
|
</argument>
|
|
<argument index="1" name="ofs" type="Vector2">
|
|
</argument>
|
|
<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">
|
|
</return>
|
|
<argument index="0" name="idx" type="int">
|
|
</argument>
|
|
<argument index="1" name="texture" type="Texture">
|
|
</argument>
|
|
<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">
|
|
</return>
|
|
<argument index="0" name="size" type="Vector2">
|
|
</argument>
|
|
<description>
|
|
Sets the size of this [LargeTexture].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|