godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/AtlasTexture.xml

72 lines
2.1 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AtlasTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Documentation for AtlasTexture.
2017-09-13 05:42:53 +00:00
Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Documentation for AtlasTexture.
2017-09-13 05:42:53 +00:00
[Texture] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture], a margin that defines the border width,
and a region that defines the actual area of the AtlasTexture.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_atlas" qualifiers="const">
<return type="Texture">
</return>
<description>
</description>
</method>
<method name="get_margin" qualifiers="const">
<return type="Rect2">
</return>
<description>
</description>
</method>
<method name="get_region" qualifiers="const">
<return type="Rect2">
</return>
<description>
</description>
</method>
<method name="set_atlas">
<return type="void">
</return>
<argument index="0" name="atlas" type="Texture">
</argument>
<description>
</description>
</method>
<method name="set_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="Rect2">
</argument>
<description>
</description>
</method>
<method name="set_region">
<return type="void">
</return>
<argument index="0" name="region" type="Rect2">
</argument>
<description>
</description>
</method>
</methods>
<members>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas">
Documentation for AtlasTexture.
2017-09-13 05:42:53 +00:00
The texture that contains the atlas. Can be any [Texture] subtype.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="margin" type="Rect2" setter="set_margin" getter="get_margin">
Documentation for AtlasTexture.
2017-09-13 05:42:53 +00:00
The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="region" type="Rect2" setter="set_region" getter="get_region">
Documentation for AtlasTexture.
2017-09-13 05:42:53 +00:00
The AtlasTexture's used region.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants>
</constants>
</class>