1. Epic GamesDeveloper
  3. FTextureSource

FTextureSource

Texture source data management.

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

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/Texture.h
Include #include "Engine/Texture.h"

Syntax

USTRUCT ()  
struct FTextureSource

Remarks

Texture source data management.

Constructors

  Type Name Description
Public function   Default constructor.

Functions

  Type Name Description
Public function Const bool  
Public function Const int64

CalcMipOffset ( int32 BlockIndex,
int32 LayerIndex,
int32 MipIndex
)

 Retrieve the size and offset for a source mip. The size includes all slices.
Public function Const int64

CalcMipSize ( int32 BlockIndex,
int32 LayerIndex,
int32 MipIndex
)

 Computes the size of a single mip in bytes.
Public function Const int64

CalcMipSize ( int32 MipIndex
)

  
Public function void PNG Compresses the source art if possible or tells the bulk data to zlib compress when it saves out to disk.
Public function Const bool

ComputeChannelLinearMinMax ( int32 InLayerIndex,
FLinearColor& OutMinColor,
FLinearColor& OutMaxColor
)

  
Public function Const FTextureSource Make a copy with a torn-off BulkData that has the same Guid used for DDC as this->BulkData
Public function void Support for copy/paste
Public function void Force the GUID to change even if mip data has not been modified.
Public function Const void

GetBlock ( int32 Index,
FTextureSourceBlock& OutBlock
)

 Access the given block
Public function FSharedBuffer GetBulkDataPayload returns the raw bulkdata memory in compressed form, not decompressed (use LockMip or GetMipData for that) the shared buffer should be treated as read only! to modify, make a copy and call Init() on the source with the changed copy
Public function Const int64

GetBytesPerPixel ( int32 LayerIndex
)

 Computes the number of bytes per-pixel.
Public function Static int64 Should match ERawImageFormat::GetBytesPerPixel
Public function Const ETextureSourceFormat

GetFormat ( int32 LayerIndex
)

  
Public function Const EGammaSpace

GetGammaSpace ( int LayerIndex
)

 Get GammaSpace for this Source (asks owner)
Public function Const FGuid

GetId ()

 GetId() returns a hash of the Id member (data hash) and also the attributes of the Source.
Public function Const FString Returns the unique ID string for this source art.
Public function Const void  
Public function Const FIntPoint Logical size of the texture includes all blocks
Public function bool

GetMipData ( TArray64< uint8 >& OutMipData,
int32 BlockIndex,
int32 LayerIndex,
int32 MipIndex,
IImageWrapperModule* ImageWrapperModule
)

 Retrieve a copy of the data for a particular mip. Prefer GetMipImage.
Public function bool

GetMipData ( TArray64< uint8 >& OutMipData,
int32 MipIndex,
IImageWrapperModule* ImageWrapperModule
)

 Legacy API that defaults to LayerIndex 0. Prefer GetMipImage.
Public function FMipData

GetMipData ( IImageWrapperModule* ImageWrapperModule
)

 Returns a FMipData structure that wraps around the entire mip chain for read only operations.
Public function bool

GetMipImage ( FImage& OutImage,
int32 BlockIndex,
int32 LayerIndex,
int32 MipIndex
)

 Retrieve a copy of the MipData as an FImage.
Public function bool

GetMipImage ( FImage& OutImage,
int32 MipIndex
)

 Retrieve a copy of the MipData as an FImage
Public function Const bool

GetMipImageInfo ( FImageInfo& OutImageInfo,
int32 BlockIndex,
int32 LayerIndex,
int32 MipIndex
)

 Get ImageInfo of one mip.
Public function Const int

GetMippedNumSlices ( int NumSlices,
int MipIndex
)

 Get mipped number of slices (volumes mip but arrays don't)
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const FGuid Trivial accessors.
Public function Const FIntPoint Size of texture in blocks
Public function Const int64 Note: simple queries on BulkData are not taking the BulkDataLock , nor does BulkData internally mutex protect these
Public function Const int64  
Public function Const int64  
Public function Const ETextureSourceCompressionFormat Returns the compression format of the source data in enum format.
Public function Const FString Returns the compression format of the source data in string format for use with the UI.
Public function Const ETextureClass Get TextureClass for this Source (asks owner)
Public function Const int64 Total number of pixels in the top mip level over all blocks+layers.
Public function Const int Returns volume depth, or 1 if not a volume
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void

ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

  
Public function void

Init ( const FImageView& Image
)

 Init and copy in texture bits from Image
Public function void

Init ( int32 NewSizeX,
int32 NewSizeY,
int32 NewNumSlices,
int32 NewNumMips,
ETextureSourceFormat NewFormat,
UE::Serialization::FEditorBulkData::FSharedBufferWithID NewData
)

 Initialize the source data with the given size, number of mips, and format.
Public function void

Init ( int32 NewSizeX,
int32 NewSizeY,
int32 NewNumSlices,
int32 NewNumMips,
ETextureSourceFormat NewFormat,
const uint8* NewData
)

 Initialize the source data with the given size, number of mips, and format.
Public function void

Init2DWithMipChain ( int32 NewSizeX,
int32 NewSizeY,
ETextureSourceFormat NewFormat
)

 Initializes the source data for a 2D texture with a full mip chain.
Public function void

InitBlocked ( const ETextureSourceFormat* InLayerFormats,
const FTextureSourceBlock* InBlocks,
int32 InNumLayers,
int32 InNumBlocks,
UE::Serialization::FEditorBulkData::FSharedBufferWithID NewData
)

  
Public function void

InitBlocked ( const ETextureSourceFormat* InLayerFormats,
const FTextureSourceBlock* InBlocks,
int32 InNumLayers,
int32 InNumBlocks,
const uint8** InDataPerBlock
)

  
Public function void

InitCubeWithMipChain ( int32 NewSizeX,
int32 NewSizeY,
ETextureSourceFormat NewFormat
)

 Initializes the source data for a cubemap with a full mip chain.
Public function void

InitLayered ( int32 NewSizeX,
int32 NewSizeY,
int32 NewNumSlices,
int32 NewNumLayers,
int32 NewNumMips,
const ETextureSourceFormat* NewLayerFormat,
const uint8* NewData
)

  
Public function void

InitLayered ( int32 NewSizeX,
int32 NewSizeY,
int32 NewNumSlices,
int32 NewNumLayers,
int32 NewNumMips,
const ETextureSourceFormat* NewLayerFormat,
UE::Serialization::FEditorBulkData::FSharedBufferWithID NewData
)

  
Public function void

InitLayered2DWithMipChain ( int32 NewSizeX,
int32 NewSizeY,
int32 NewNumLayers,
const ETextureSourceFormat* NewFormat
)

  
Public function void

InitWithCompressedSourceData ( int32 NewSizeX,
int32 NewSizeY,
int32 NewNumMips,
ETextureSourceFormat NewFormat,
const TArrayView64< uint8 > NewSourceData,
ETextureSourceCompressionFormat NewSourceFormat
)

 Initialize the source data with the given size, number of mips, and format.
Public function void Initialize the source data with the given size, number of mips, and format.
Public function Const bool

IsBlockPowerOfTwo ( int32 BlockIndex
)

 Return true if the source XY size is power-of-2. Does not check Z size for volumes.
Public function Const bool Returns true if the texture's bulkdata payload is either already in memory or if the payload is 0 bytes in length.
Public function Const bool Warning: bLongLatCubemap is not correct.
Public function Static bool Should match ERawImageFormat::IsHDR
Public function Const bool  
Public function Const bool

IsPowerOfTwo ( int32 BlockIndex
)

 Return true if the source XY size is power-of-2. Does not check Z size for volumes.
Public function Const bool  
Public function Const bool

IsValid ()

 Returns true if source art is available.
Public function Const bool  
Public function bool  
Public function uint8 *

LockMip ( int32 BlockIndex,
int32 LayerIndex,
int32 MipIndex
)

 Lock a mip for editing. Note that Lock/Unlock for edit automatically does UseHashAsGuid.
Public function uint8 *

LockMip ( int32 MipIndex
)

 Lock a mip for editing.
Public function const uint8 *

LockMipReadOnly ( int32 MipIndex
)

 Lock a mip for reading.
Public function const uint8 *

LockMipReadOnly ( int32 BlockIndex,
int32 LayerIndex,
int32 MipIndex
)

 Use FMipLock to encapsulate a locked mip Lock a mip for reading.
Public function void

OperateOnLoadedBulkData ( TFunctionRef< void(const FSharedBuffer&BulkDataBuffer)> Operation
)

 Apply a visitor to the bulkdata : prefer GetBulkDataPayload() instead.
Public function void  
Public function void  
Public function void  
Public function void

Reset ()

 Reset the source to empty, frees all memory.
Public function void  
Public function void

SetId ( const FGuid& InId,
bool bInGuidIsHash
)

 Sets the GUID to use, and whether that GUID is actually a hash of some data.
Public function void

SetLayerColorInfo ( const TArray< FTextureSourceLayerColorInfo >& InLayerColorInfo
)

  
Public function void

SetOwner ( UTexture* InOwner
)

  
Public function void

UnlockMip ( int32 BlockIndex,
int32 LayerIndex,
int32 MipIndex
)

 Unlock a mip.
Public function void

UnlockMip ( int32 MipIndex
)

  
Public function bool UpdateChannelLinearMinMax runs FImageCore::ComputeChannelLinearMinMax on all blocks and layers (but only mip0), returns false if the source was unable to be locked and leaves the channel minmax as unknown.
Public function bool As per UpdateChannelLinearMinMax(), except acts on incoming new data rather than locking existing mips.
Public function void Uses a hash as the GUID, useful to prevent creating new GUIDs on load for legacy assets.

Classes

  Type Name Description
Public struct FMipAllocation    
Public struct FMipData Structure that encapsulates the decompressed texture data and can be accessed per mip  
Public struct FMipLock FMipLock to encapsulate a locked mip - acquires the lock in construct and unlocks in destruct.  

Enums

  Type Name Description
Public enum ELockState    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page