Navigation
API > API/Plugins > API/Plugins/Paper2D
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)
| Name | UPaperSpriteAtlas |
| Type | class |
| Header File | /Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperSpriteAtlas.h |
| Include Path | #include "PaperSpriteAtlas.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Experimental, Meta=(DisplayThumbnail="true"))
class UPaperSpriteAtlas : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPaperSpriteAtlas
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPaperSpriteAtlas
(
const FObjectInitializer& ObjectInitializer |
PaperSpriteAtlas.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AtlasDescription | FString | Description of this atlas, which shows up in the content browser tooltip. | PaperSpriteAtlas.h |
|
| AtlasGUID | FGuid | The GUID of the atlas group, used to match up sprites that belong to this group even thru atlas renames. | PaperSpriteAtlas.h |
|
| AtlasSlots | TArray< FPaperSpriteAtlasSlot > | Slots in the atlas. | PaperSpriteAtlas.h | |
| bRebuildAtlas | bool | Slots in the atlas. | PaperSpriteAtlas.h |
|
| BuiltHeight | int32 | PaperSpriteAtlas.h | ||
| BuiltPadding | int32 | PaperSpriteAtlas.h | ||
| BuiltWidth | int32 | Values used when building this atlas. | PaperSpriteAtlas.h | |
| CompressionSettings | TEnumAsByte< TextureCompressionSettings > | Compression settings to use on atlas texture. | PaperSpriteAtlas.h |
|
| Filter | TEnumAsByte< TextureFilter > | Texture filtering mode when sampling these textures. | PaperSpriteAtlas.h |
|
| GeneratedTextures | TArray< TObjectPtr< UTexture > > | List of generated atlas textures. | PaperSpriteAtlas.h |
|
| MaxHeight | int32 | Maximum atlas page height (single pages might be smaller) | PaperSpriteAtlas.h |
|
| MaxWidth | int32 | Maximum atlas page width (single pages might be smaller) | PaperSpriteAtlas.h |
|
| MipCount | int32 | Maximum atlas page height (single pages might be smaller) | PaperSpriteAtlas.h |
|
| NumIncrementalBuilds | int32 | Track the number of incremental builds. | PaperSpriteAtlas.h | |
| Padding | int32 | The number of pixels of padding. | PaperSpriteAtlas.h |
|
| PaddingType | EPaperSpriteAtlasPadding | The type of padding performed on this atlas. | PaperSpriteAtlas.h |
|
Functions
Public
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
PaperSpriteAtlas.h | ||
virtual void GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
PaperSpriteAtlas.h | ||
virtual void PostDuplicate
(
bool bDuplicateForPIE |
PaperSpriteAtlas.h | ||
virtual void PostInitProperties() |
PaperSpriteAtlas.h |