diff options
Diffstat (limited to 'doc/classes/LargeTexture.xml')
-rw-r--r-- | doc/classes/LargeTexture.xml | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml new file mode 100644 index 0000000000..e4cabdc556 --- /dev/null +++ b/doc/classes/LargeTexture.xml @@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="LargeTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build"> + <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(Textures) to this fLargeTexture] using different offsets. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <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> + Add another [Texture] to this [LargeTexture], starting on offset "ofs". + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear the [LargeTexture]. + </description> + </method> + <method name="get_piece_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return 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> + Return the offset of the piece with index "idx". + </description> + </method> + <method name="get_piece_texture" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the [Texture] of the piece with index "idx". + </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> + Set the offset of the piece with index "idx" to "ofs". + </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> + Set the [Texture] of the piece with index "idx" to "ofs". + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Set the size of this [LargeTexture]. + </description> + </method> + </methods> + <members> + <member name="_data" type="Array" setter="_set_data" getter="_get_data"> + </member> + </members> + <constants> + </constants> +</class> |