mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
45 lines
1.6 KiB
ReStructuredText
45 lines
1.6 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the AtlasTexture.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_AtlasTexture:
|
|
|
|
AtlasTexture
|
|
============
|
|
|
|
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
|
|
|
|
Description
|
|
-----------
|
|
|
|
:ref:`Texture<class_Texture>` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture<class_Texture>`, a margin that defines the border width,
|
|
|
|
and a region that defines the actual area of the AtlasTexture.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_AtlasTexture_atlas:
|
|
|
|
- :ref:`Texture<class_Texture>` **atlas** - The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` subtype.
|
|
|
|
.. _class_AtlasTexture_filter_clip:
|
|
|
|
- :ref:`bool<class_bool>` **filter_clip** - If ``true`` clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
|
|
|
|
.. _class_AtlasTexture_margin:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **margin** - The margin around the region. The :ref:`Rect2<class_Rect2>`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.
|
|
|
|
.. _class_AtlasTexture_region:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **region** - The AtlasTexture's used region.
|
|
|
|
|