1. Epic GamesDeveloper
  3. FSlateTextureAtlas

FSlateTextureAtlas

Base class texture atlases in Slate

Unreal Engine C++ API Reference > Runtime > SlateCore > Textures

Inheritance Hierarchy

References

   
Module SlateCore
Header /Engine/Source/Runtime/SlateCore/Public/Textures/TextureAtlas.h
Include #include "Textures/TextureAtlas.h"

Syntax

class FSlateTextureAtlas

Remarks

Base class texture atlases in Slate

Variables

  Type Name Description
Protected variable TArray< uint8 > AtlasData Actual texture data contained in the atlas
Protected variable FAtlasedTextureSlot * AtlasEmptySlots The list of atlas slots pointing to empty texture data in the atlas
Protected variable uint32 AtlasHeight Height of the atlas
Protected variable ESlateTextureAtlasThreadId AtlasOwnerThread The type of thread that owns this atlas - this is the only thread that can safely update it NOTE: We don't use the thread ID here, as the render thread can be recreated if it gets suspended and resumed, giving it a new ID
Protected variable FAtlasedTextureSlot * AtlasUsedSlots The list of atlas slots pointing to used texture data in the atlas
Protected variable uint32 AtlasWidth Width of the atlas
Protected variable bool bNeedsUpdate True if this texture needs to have its rendering resources updated
Protected variable bool bUpdatesAfterInitialization True if this texture can update after initialziation and we should preserve the atlas slots and cpu memory
Protected variable uint32 BytesPerPixel Bytes per pixel in the atlas
Protected variable ESlateTextureAtlasPaddingStyle PaddingStyle Padding style

Constructors

  Type Name Description
Public function  

FSlateTextureAtlas ( uint32 InWidth,
uint32 InHeight,
uint32 InBytesPerPixel,
ESlateTextureAtlasPaddingStyle InPaddingStyle,
bool bInUpdatesAfterInitialization
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function const FAtlasedTextureSlot *

AddTexture ( uint32 TextureWidth,
uint32 TextureHeight,
const TArray< uint8 >& Data
)

 Adds a texture to the atlas
Public function void Updates the texture used for rendering if needed
Protected function void

CopyDataIntoSlot ( const FAtlasedTextureSlot* SlotToCopyTo,
const TArray< uint8 >& Data
)

 Copies texture data into the atlas at a given slot
Protected function void

CopyRow ( const FCopyRowData& CopyRowData
)

 Copies a single row from a source texture to a dest texture, respecting the padding.
Public function void Clears atlas cpu data. It does not clear rendering data
Protected function const FAtlasedTextureSlot *

FindSlotForTexture ( uint32 InWidth,
uint32 InHeight
)

 Finds the optimal slot for a texture in the atlas
Public function Const FSlateShaderResource *  
Public function Const uint32  
Public function Const const FAtlasedTextureSlot *

GetSlotAtPosition ( FIntPoint InPosition
)

  
Public function Const uint32  
Protected function void Creates enough space for a single texture the width and height of the atlas
Public function void Marks the texture as dirty and needing its rendering resources updated
Public function void Releases rendering resources of this texture
Protected function void

ZeroRow ( const FCopyRowData& CopyRowData
)

 Zeros out a row in the dest texture (used with PaddingStyle == PadWithZero).

Classes

  Type Name Description
Protected struct FCopyRowData    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page