AtlasTexture

Inherits: Texture2D < Texture < Resource < RefCounted < Object

Crops out one part of a texture, such as a texture from a texture atlas.

Description

Texture2D resource that crops out one part of the atlas texture, defined by region. The main use case is cropping out textures from a texture atlas, which is a big texture file that packs multiple smaller textures. Consists of a Texture2D for the atlas, a region that defines the area of atlas to use, and a margin that defines the border width.

AtlasTexture cannot be used in an AnimatedTexture, cannot be tiled in nodes such as TextureRect, and does not work properly if used inside of other AtlasTexture resources. Multiple AtlasTexture resources can be used to crop multiple textures from the atlas. Using a texture atlas helps to optimize video memory costs and render calls compared to using multiple small files.

Properties

Texture2D

atlas

bool

filter_clip

false

Rect2

margin

Rect2(0, 0, 0, 0)

Rect2

region

Rect2(0, 0, 0, 0)

Property Descriptions

Setter

set_atlas(value)

Getter

get_atlas()

The texture that contains the atlas. Can be any Texture2D subtype.


Default

false

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.


Default

Rect2(0, 0, 0, 0)

Setter

set_margin(value)

Getter

get_margin()

The margin around the region. The Rect2's Rect2.size parameter ("w" and "h" in the editor) resizes the texture so it fits within the margin.


Default

Rect2(0, 0, 0, 0)

Setter

set_region(value)

Getter

get_region()

The AtlasTexture's used region.