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)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Paper2D

Header

/Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperSpriteAtlas.h

Include

#include "PaperSpriteAtlas.h"

Syntax

UCLASS(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

Public variable UProperty Category, EditAnywhere

FString

 

AtlasDescription

Description of this atlas, which shows up in the content browser tooltip.

Public variable UProperty Category visibleanywhere

FGuid

 

AtlasGUID

The GUID of the atlas group, used to match up sprites that belong to this group even thru atlas renames.

Public variable UProperty

TArray< FPaperS...

 

AtlasSlots

Slots in the atlas.

Public variable UProperty Category, EditAnywhere

bool

 

bRebuildAtlas

Slots in the atlas.

Public variable UProperty

int32

 

BuiltHeight

Public variable UProperty

int32

 

BuiltPadding

Public variable UProperty

int32

 

BuiltWidth

Values used when building this atlas.

Public variable UProperty Category, EditAnywhere

TEnumAsByte< en...

 

CompressionSettings

Compression settings to use on atlas texture.

Public variable UProperty Category, EditAnywhere

TEnumAsByte< en...

 

Filter

Texture filtering mode when sampling these textures.

Public variable UProperty Category visibleanywhere

TArray< TObject...

 

GeneratedTextures

List of generated atlas textures.

Public variable UProperty Category, EditAnywhere

int32

 

MaxHeight

Maximum atlas page height (single pages might be smaller)

Public variable UProperty Category, EditAnywhere

int32

 

MaxWidth

Maximum atlas page width (single pages might be smaller)

Public variable UProperty Category, EditAnywhere

int32

 

MipCount

Maximum atlas page height (single pages might be smaller)

Public variable UProperty

int32

 

NumIncrementalBuilds

Track the number of incremental builds.

Public variable UProperty Category, EditAnywhere

int32

 

Padding

The number of pixels of padding.

Public variable UProperty Category, EditAnywhere

EPaperSpriteAtl...

 

PaddingType

The type of padding performed on this atlas.

Constructors

Name Description

Public function

UPaperSpriteAtlas

(
    const FObjectInitializer& ObjectIn...
)

Overridden from UObject

Name Description

Public function Virtual Const

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

Public function Virtual

void

 

PostDuplicate

(
    bool bDuplicateForPIE
)

Called after duplication & serialization and before PostLoad.

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.