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
31 lines
1.4 KiB
XML
31 lines
1.4 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AtlasTexture" inherits="Texture" category="Core" version="3.2">
|
|
<brief_description>
|
|
Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
|
|
</brief_description>
|
|
<description>
|
|
[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.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
</methods>
|
|
<members>
|
|
<member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas">
|
|
The texture that contains the atlas. Can be any [Texture] subtype.
|
|
</member>
|
|
<member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip">
|
|
If [code]true[/code], clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
|
|
</member>
|
|
<member name="margin" type="Rect2" setter="set_margin" getter="get_margin">
|
|
The margin around the region. The [Rect2]'s [member Rect2.size] parameter ("w" and "h" in the editor) resizes the texture so it fits within the margin.
|
|
</member>
|
|
<member name="region" type="Rect2" setter="set_region" getter="get_region">
|
|
The AtlasTexture's used region.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|