| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091 |
- :github_url: hide
- .. 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.
- Properties
- ----------
- +-------------------------------+-------------------------------------------------------------+
- | :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_property_atlas>` |
- +-------------------------------+-------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` |
- +-------------------------------+-------------------------------------------------------------+
- | :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_property_margin>` |
- +-------------------------------+-------------------------------------------------------------+
- | :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_property_region>` |
- +-------------------------------+-------------------------------------------------------------+
- 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_property_atlas:
- - :ref:`Texture<class_Texture>` **atlas**
- +----------+------------------+
- | *Setter* | set_atlas(value) |
- +----------+------------------+
- | *Getter* | get_atlas() |
- +----------+------------------+
- The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` subtype.
- .. _class_AtlasTexture_property_filter_clip:
- - :ref:`bool<class_bool>` **filter_clip**
- +----------+------------------------+
- | *Setter* | set_filter_clip(value) |
- +----------+------------------------+
- | *Getter* | has_filter_clip() |
- +----------+------------------------+
- If ``true``, clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
- .. _class_AtlasTexture_property_margin:
- - :ref:`Rect2<class_Rect2>` **margin**
- +----------+-------------------+
- | *Setter* | set_margin(value) |
- +----------+-------------------+
- | *Getter* | get_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_property_region:
- - :ref:`Rect2<class_Rect2>` **region**
- +----------+-------------------+
- | *Setter* | set_region(value) |
- +----------+-------------------+
- | *Getter* | get_region() |
- +----------+-------------------+
- The AtlasTexture's used region.
|
