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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

28 lines
1.8 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" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="AtlasTexture" inherits="Texture2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
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>
Improve AtlasTexture's Documentation Reduces repetition, rearranges sentences to improve structure, attempts to be more impersonal ("clips" -> "is_clipped") and consistent with other more common classes. Also remove outdated snippet from the description ("cannot be tiled in nodes such as TextureRect" is no longer true in master).
2022-09-26 14:12:56 +00:00
A texture that crops out part of another Texture2D.
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>
Improve AtlasTexture's Documentation Reduces repetition, rearranges sentences to improve structure, attempts to be more impersonal ("clips" -> "is_clipped") and consistent with other more common classes. Also remove outdated snippet from the description ("cannot be tiled in nodes such as TextureRect" is no longer true in master).
2022-09-26 14:12:56 +00:00
[Texture2D] resource that draws only part of its [member atlas] texture, as defined by the [member region]. An additional [member margin] can also be set, which is useful for small adjustments.
Multiple [AtlasTexture] resources can be cropped from the same [member atlas]. Packing many smaller textures into a singular large texture helps to optimize video memory costs and render calls.
[b]Note:[/b] [AtlasTexture] cannot be used in an [AnimatedTexture], and does not work properly if used inside of other [AtlasTexture] resources.
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>
<members>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<member name="atlas" type="Texture2D" setter="set_atlas" getter="get_atlas">
Improve AtlasTexture's Documentation Reduces repetition, rearranges sentences to improve structure, attempts to be more impersonal ("clips" -> "is_clipped") and consistent with other more common classes. Also remove outdated snippet from the description ("cannot be tiled in nodes such as TextureRect" is no longer true in master).
2022-09-26 14:12:56 +00:00
The texture that contains the atlas. Can be any type inheriting from [Texture2D]. Nesting [AtlasTexture] resources is not supported.
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">
Improve AtlasTexture's Documentation Reduces repetition, rearranges sentences to improve structure, attempts to be more impersonal ("clips" -> "is_clipped") and consistent with other more common classes. Also remove outdated snippet from the description ("cannot be tiled in nodes such as TextureRect" is no longer true in master).
2022-09-26 14:12:56 +00:00
If [code]true[/code], the area outside of the [member region] is clipped to avoid bleeding of the surrounding texture pixels.
classref: Sync with current source [ci skip]
2017-11-13 08:24:36 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="margin" type="Rect2" setter="set_margin" getter="get_margin" default="Rect2(0, 0, 0, 0)">
Improve AtlasTexture's Documentation Reduces repetition, rearranges sentences to improve structure, attempts to be more impersonal ("clips" -> "is_clipped") and consistent with other more common classes. Also remove outdated snippet from the description ("cannot be tiled in nodes such as TextureRect" is no longer true in master).
2022-09-26 14:12:56 +00:00
The margin around the [member region]. Useful for small adjustments. If the [member Rect2.size] of this property ("w" and "h" in the editor) is set, the drawn texture is resized to fit 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>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="region" type="Rect2" setter="set_region" getter="get_region" default="Rect2(0, 0, 0, 0)">
Improve AtlasTexture's Documentation Reduces repetition, rearranges sentences to improve structure, attempts to be more impersonal ("clips" -> "is_clipped") and consistent with other more common classes. Also remove outdated snippet from the description ("cannot be tiled in nodes such as TextureRect" is no longer true in master).
2022-09-26 14:12:56 +00:00
The region used to draw the [member atlas].
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>
</class>