AtlasTexture¶

Inherits: Texture < Resource < Reference < Object

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

Description¶

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

Note: AtlasTextures don't support repetition. The Texture.FLAG_REPEAT and Texture.FLAG_MIRRORED_REPEAT flags are ignored when using an AtlasTexture.

Properties¶

Texture	atlas
bool	filter_clip	`false`
int	flags	`0` (overrides Texture)
Rect2	margin	`Rect2( 0, 0, 0, 0 )`
Rect2	region	`Rect2( 0, 0, 0, 0 )`

Property Descriptions¶

Texture atlas

void set_atlas ( Texture value )
Texture get_atlas ( )

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

bool filter_clip = false

void set_filter_clip ( bool value )
bool has_filter_clip ( )

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

Rect2 margin = Rect2( 0, 0, 0, 0 )

void set_margin ( Rect2 value )
Rect2 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.

Rect2 region = Rect2( 0, 0, 0, 0 )

void set_region ( Rect2 value )
Rect2 get_region ( )

The AtlasTexture's used region.