Class AtlasTexture

A texture that crops out part of another Texture2D.

Inheritance

Texture2D

Texture

Resource

RefCounted

Object

AtlasTexture

Remarks

Texture2D resource that draws only part of its atlas texture, as defined by the region. An additional margin can also be set, which is useful for small adjustments.

Multiple AtlasTexture resources can be cropped from the same atlas. Packing many smaller textures into a singular large texture helps to optimize video memory costs and render calls.

Note: AtlasTexture cannot be used in an AnimatedTexture, and will not tile properly in nodes such as TextureRect or Sprite2D. To tile an AtlasTexture, modify its region instead.

Properties

atlas

The texture that contains the atlas. Can be any type inheriting from Texture2D, including another AtlasTexture.

var atlas : Texture2D

Property Value

Texture2D

Remarks

• void set_atlas(Texture2D value)
• Texture2D get_atlas

filter_clip

If true, the area outside of the region is clipped to avoid bleeding of the surrounding texture pixels.

var filter_clip : bool = false

Property Value

bool

Remarks

• void set_filter_clip(bool value)
• bool has_filter_clip

margin

The margin around the region. Useful for small adjustments. If the size of this property ("w" and "h" in the editor) is set, the drawn texture is resized to fit within the margin.

var margin : Rect2 = Rect2(0, 0, 0, 0)

Property Value

Rect2

Remarks

• void set_margin(Rect2 value)
• Rect2 get_margin

region

The region used to draw the atlas. If either dimension of the region's size is 0, the value from atlas size will be used for that axis instead.

var region : Rect2 = Rect2(0, 0, 0, 0)

Property Value

Rect2

Remarks

• void set_region(Rect2 value)
• Rect2 get_region