Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Paper2D > UPaperSpriteAtlas

Light Theme

Dark Theme

UPaperSpriteAtlas

Groups together a set of sprites that will try to share the same texture atlas (allowing them to be combined into a single draw call)

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UPaperSpriteAtlas

References

Module	Paper2D
Header	/Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperSpriteAtlas.h
Include	#include "PaperSpriteAtlas.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI, BlueprintType, Experimental, Meta=(DisplayThumbnail="true"))
class UPaperSpriteAtlas : public UObject

Remarks

Groups together a set of sprites that will try to share the same texture atlas (allowing them to be combined into a single draw call)

Variables

	Name	Description
FString	AtlasDescription	Description of this atlas, which shows up in the content browser tooltip.
FGuid	AtlasGUID	The GUID of the atlas group, used to match up sprites that belong to this group even thru atlas renames.
TArray< FPaperS...	AtlasSlots	Slots in the atlas.
bool	bRebuildAtlas	Slots in the atlas.
int32	BuiltHeight
int32	BuiltPadding
int32	BuiltWidth	Values used when building this atlas.
TEnumAsByte< en...	CompressionSettings	Compression settings to use on atlas texture.
TEnumAsByte< en...	Filter	Texture filtering mode when sampling these textures.
TArray< UTextur...	GeneratedTextures	List of generated atlas textures.
int32	MaxHeight	Maximum atlas page height (single pages might be smaller)
int32	MaxWidth	Maximum atlas page width (single pages might be smaller)
int32	MipCount	Maximum atlas page height (single pages might be smaller)
int32	NumIncrementalBuilds	Track the number of incremental builds.
int32	Padding	The number of pixels of padding.
EPaperSpriteAtl...	PaddingType	The type of padding performed on this atlas.

Constructors

	Name	Description
	UPaperSpriteAtlas ( const FObjectInitializer& ObjectIn... )

Overridden from UObject

	Name	Description
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss