Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > UTexture2D

Light Theme

Dark Theme

UTexture2D

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UStreamableRenderAsset

UTexture

UTexture2D

	UCurveLinearColorAtlas
	ULightMapTexture2D
	ULightMapVirtualTexture2D
	URuntimeVirtualTextureStreamingProxy
	UShadowMapTexture2D
	UTextureLightProfile
	UVirtualTexture2D

References

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

Syntax

class UTexture2D : public UTexture

Variables

	Name	Description
TEnumAsByte< en...	AddressX	The addressing mode to use for the X axis.
TEnumAsByte< en...	AddressY	The addressing mode to use for the Y axis.
uint8: 1	bHasBeenPaintedInEditor	Whether the texture has been painted in the editor.
TMap< FString, ...	CookedPlatformData	Cooked platform data for this texture
int32	FirstResourceMemMip	Keep track of first mip level used for ResourceMem creation
FTexture2DResou...	ResourceMem	Memory used for directly loading bulk mip data

Constructors

	Name	Description
	UTexture2D ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
int32	Blueprint_GetSizeX()	Gets the X size of the texture, in pixels
int32	Blueprint_GetSizeY()	Gets the Y size of the texture, in pixels
int32	CalcTextureMemorySize ( int32 MipCount )	Calculates the size of this texture in bytes if it had MipCount miplevels streamed in.
UTexture2D &...	CreateTransient ( int32 InSizeX, int32 InSizeY, EPixelFormat InFormat, const FName InName )	Creates and initializes a new Texture2D with the requested settings
int32	GetExtData()
float	GetGlobalMipMapLODBias()	Returns the global mip map bias applied as an offset for 2d textures.
FIntPoint	GetImportedSize()	Retrieves the size of the source image from which the texture was created.
int32	GetMinTextureResidentMipCount()	Returns the minimum number of mips that must be resident in memory (cannot be streamed).
void	GetMipData ( int32 FirstMipToLoad, void** OutMipData )	Get mip data starting with the specified mip index.
int32	GetMipTailBaseIndex()
int32	GetNumMips()
int32	GetNumMipsAllowed ( bool bIgnoreMinResidency )	Calculates the maximum number of mips the engine allows to be loaded for this texture.
int32	GetNumResidentMips()
EPixelFormat	GetPixelFormat ( uint32 LayerIndex )
const FTextu...	GetPlatformData()	Get the const derived data for this texture on this platform.
FTexturePlat...	GetPlatformData()	Get the derived data for this texture on this platform.
const TIndir...	GetPlatformMips()
bool	GetResourceMemSettings ( int32 FirstMipIdx, int32& OutSizeX, int32& OutSizeY, int32& OutNumMips, uint32& OutTexCreateFlags )	Calculates and returns the corresponding ResourceMem parameters for this texture.
int32	GetSizeX()	Trivial accessors.
int32	GetSizeY()
bool	GetSourceArtCRC ( uint32& OutSourceCRC )	Get the CRC of the source art pixels.
bool	HasAlphaChannel()	Returns true if the runtime texture has an alpha channel that is not completely white.
bool	HasSameSourceArt ( UTexture2D* InTexture )	See if the source art of the two textures matches...
bool	IsVirtualTexturedWithContinuousUpdate()	Returns true if this virtual texture requests round-robin updates of the virtual texture pages.
bool	IsVirtualTexturedWithSinglePhysicalSpace()	Returns true if this virtual texture uses a single physical space all of its texture layers.
void	RefreshSamplerStates()	Update the offset for mip map lod bias. This is added to any existing mip bias values.
void	SetPlatformData ( FTexturePlatformData* Platform... )	Set the derived data for this texture on this platform.
void	TemporarilyDisableStreaming()	Temporarily disable streaming so we update subregions of this texture without streaming clobbering it.
void	UpdateTextureRegions ( int32 MipIndex, uint32 NumRegions, const FUpdateTextureRegion2D* ..., uint32 SrcPitch, uint32 SrcBpp, uint8* SrcData, TFunction< void*SrcData,... )	Asynchronously update a set of regions of a texture with new data.

Overridden from UTexture

	Name	Description
uint32	CalcTextureMemorySizeEnum ( ETextureMipCount Enum )	Calculates the size of this texture if it had MipCount miplevels streamed in.
FTextureReso...	CreateResource()	Implemented by subclasses to create a new resource for the texture.
float	GetAverageBrightness ( bool bIgnoreTrueBlack, bool bUseGrayscale )	Gets the average brightness of the texture (in linear space)
TMap< FStrin...	GetCookedPlatformData()
EMaterialVal...	GetMaterialType()
FTexturePlat...	GetRunningPlatformData()	Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data.
bool	GetStreamableRenderResourceState ( FTexturePlatformData* InPlatfo..., FStreamableRenderResourceState& Ou... )
uint32	GetSurfaceArraySize()
float	GetSurfaceDepth()
float	GetSurfaceHeight()
float	GetSurfaceWidth()
TextureAddre...	GetTextureAddressX()
TextureAddre...	GetTextureAddressY()
bool	IsCurrentlyVirtualTextured()	Returns if the texture is actually being rendered using virtual texturing right now.
bool	IsDefaultTexture()	Returns true if the current texture is a default placeholder because compilation is still ongoing.
void	UpdateResource()	Creates a new resource for the texture, and updates any cached references to the resource.

Overridden from UStreamableRenderAsset

	Name	Description
int32	CalcCumulativeLODSize ( int32 NumLODs )
bool	StreamIn ( int32 NewMipCount, bool bHighPrio )	Loads mips from disk to memory. Only usable if the asset is streamable.
bool	StreamOut ( int32 NewMipCount )	Unload some mips from memory. Only usable if the asset is streamable.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
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
FString	GetDesc()	Return a one line description of an object for viewing in the thumbnail view of the generic browser
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	Returns the size of the object/ resource for display to artists/ LDs in the Editor.
bool	IsReadyForAsyncPostLoad()	Called before calling PostLoad() in FAsyncPackage::PostLoadObjects().
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostEditUndo()	Called after an editor or undo operation is formed on texture
void	PostLinkerChange()	Called in response to the linker changing, this can only happen in the editor
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreSave ( FObjectPreSaveContext SaveContext )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	TFieldPtrAccess...	PlatformData	Use GetPlatformData() / SetPlatformData() accessors instead.

Deprecated Functions

		Name	Description
	void	PreSave ( const ITargetPlatform* TargetP... )	Use version that takes FObjectPreSaveContext instead.