godot-docs/classes/class_atlastexture.rst

.. 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.

Member Variables
----------------

  .. _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.


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.