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

31 lines
1.5 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" ?>
doc: Drop unused 'category' property from header We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-26 15:01:49 +00:00
<class name="AtlasTexture" inherits="Texture" version="3.2">
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>
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>
Mention that AnimatedTexture doesn't support atlases
2019-09-13 12:04:57 +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>
<methods>
</methods>
<members>
doc: Sync classref with current source
2019-07-15 18:42:47 +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: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
classref: Sync with current source [ci skip]
2017-11-13 08:24:36 +00:00
</member>
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
2019-09-24 11:34:03 +00:00
<member name="flags" type="int" setter="set_flags" getter="get_flags" override="true" default="0" />
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="margin" type="Rect2" setter="set_margin" getter="get_margin" default="Rect2( 0, 0, 0, 0 )">
Proofread and improve the whole class reference - 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
2019-06-21 23:04:47 +00:00
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.
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: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="region" type="Rect2" setter="set_region" getter="get_region" default="Rect2( 0, 0, 0, 0 )">
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>