1. Epic GamesDeveloper
  3. UPaperSpriteAtlas

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)

Unreal Engine C++ API Reference > Plugins > Paper2D

Inheritance Hierarchy

  • UObject
  • UPaperSpriteAtlas

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

  Type 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< FPaperSpriteAtlasSlot > 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< TextureCompressionSettings > CompressionSettings Compression settings to use on atlas texture.
Public variable UProperty Category, EditAnywhere TEnumAsByte< TextureFilter > Filter Texture filtering mode when sampling these textures.
Public variable UProperty Category visibleanywhere TArray< TObjectPtr< UTexture > > 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 EPaperSpriteAtlasPadding PaddingType The type of padding performed on this atlas.

Constructors

  Type Name Description
Public function  

UPaperSpriteAtlas ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const void

GetAssetRegistryTags ( FAssetRegistryTagsContext Context
)

  
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page