virtualx-engine/doc/classes/AtlasTexture.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AtlasTexture" inherits="Texture2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A texture that crops out part of another Texture2D.
	</brief_description>
	<description>
		[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 may not tile properly in nodes such as [TextureRect], when inside other [AtlasTexture] resources.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="atlas" type="Texture2D" setter="set_atlas" getter="get_atlas">
			The texture that contains the atlas. Can be any type inheriting from [Texture2D], including another [AtlasTexture].
		</member>
		<member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip" default="false">
			If [code]true[/code], the area outside of the [member region] is clipped to avoid bleeding of the surrounding texture pixels.
		</member>
		<member name="margin" type="Rect2" setter="set_margin" getter="get_margin" default="Rect2(0, 0, 0, 0)">
			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.
		</member>
		<member name="region" type="Rect2" setter="set_region" getter="get_region" default="Rect2(0, 0, 0, 0)">
			The region used to draw the [member atlas]. If either dimension of the region's size is [code]0[/code], the value from [member atlas] size will be used for that axis instead.
		</member>
		<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="false" />
	</members>
</class>
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 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="AtlasTexture" inherits="Texture2D" 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 22:42:36 +02: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 16:12:56 +02: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 22:42:36 +02: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 16:12:56 +02: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.`
Support nesting AtlasTextures inside other AtlasTextures Connects AtlasTexture to its `atlas`'s "changed" signal, allowing it to detect property changes to `atlas` and update accordingly, when the project is running and in the editor, as well. 2022-09-27 18:53:14 +02:00			`[b]Note:[/b] [AtlasTexture] cannot be used in an [AnimatedTexture], and may not tile properly in nodes such as [TextureRect], when inside 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 22:42:36 +02: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 09:59:06 +01:00			`<member name="atlas" type="Texture2D" setter="set_atlas" getter="get_atlas">`
Support nesting AtlasTextures inside other AtlasTextures Connects AtlasTexture to its `atlas`'s "changed" signal, allowing it to detect property changes to `atlas` and update accordingly, when the project is running and in the editor, as well. 2022-09-27 18:53:14 +02:00			`The texture that contains the atlas. Can be any type inheriting from [Texture2D], including another [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 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02: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 16:12:56 +02: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 09:24:36 +01:00			`</member>`
Better format arguments in variant parser 2019-09-24 19:45:03 +02: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 16:12:56 +02: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 22:42:36 +02:00			`</member>`
Better format arguments in variant parser 2019-09-24 19:45:03 +02:00			`<member name="region" type="Rect2" setter="set_region" getter="get_region" default="Rect2(0, 0, 0, 0)">`
Fix empty region in AtlasTexture 2024-07-14 23:17:39 +02:00			`The region used to draw the [member atlas]. If either dimension of the region's size is [code]0[/code], the value from [member atlas] size will be used for that axis instead.`
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 22:42:36 +02:00			`</member>`
Fix default values on virtual classes causing errors in projects 2022-11-09 08:59:49 +01:00			`<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="false" />`
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 22:42:36 +02:00			`</members>`
			`</class>`