1. Epic GamesDeveloper
  3. UTexture2D

UTexture2D

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (HideCategories=Object, MinimalAPI, BlueprintType)  
class UTexture2D : public UTexture

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite assetregistrysearchable TEnumAsByte< enum TextureAddress > AddressX The addressing mode to use for the X axis.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite assetregistrysearchable TEnumAsByte< enum TextureAddress > AddressY The addressing mode to use for the Y axis.
Public variable UProperty uint8: 1 bHasBeenPaintedInEditor Whether the texture has been painted in the editor.
Public variable TMap< FString, FTexturePlatformData * > CookedPlatformData Cooked platform data for this texture
Public variable UProperty TObjectPtr< UTexture2D > CPUCopyTexture If we ever show the CPU accessible image in the editor we'll need a transient texture with those bits in it.
Public variable UProperty int32 FirstResourceMemMip Keep track of first mip level used for ResourceMem creation
Public variable FTexture2DResourceMem * ResourceMem Memory used for directly loading bulk mip data

Constructors

  Type Name Description
Public function  

UTexture2D ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category, Meta FSharedImageConstRefBlueprint  
Public function Const UFunction BlueprintCallable, Category, Meta int32 Gets the X size of the texture, in pixels
Public function Const UFunction BlueprintCallable, Category, Meta int32 Gets the Y size of the texture, in pixels
Public function Const int32 Calculates the size of this texture in bytes if it had MipCount miplevels streamed in.
Public function Static UTexture2D *

CreateTransient ( int32 InSizeX,
int32 InSizeY,
EPixelFormat InFormat,
const FName InName,
TConstArrayView64< uint8 > InImageData
)

 Creates and initializes a new Texture2D with the requested settings.
Public function Static UTexture2D *

CreateTransientFromImage ( const FImage* InImage,
const FName InName
)

 Creates a new texture2d from the first slice of the given image.
Public function Const UTextureAllMipDataProviderFactory *  
Public function Const FSharedImageConstRef If the texture has a cpu accessible copy, this returns that copy.
Public function UTexture2D * Creates and returns a 2d texture that holds the CPU copy.
Public function Const int32  
Public function Static float Returns the global mip map bias applied as an offset for 2d textures.
Public function Const FIntPoint Retrieves the size of the source image from which the texture was created.
Public function Virtual bool

GetInitialMipData ( int32 InFirstMipToLoad,
TArrayView< void* > OutMipData,
TArrayView< int64 > OutMipSize
)

 Retrieve initial texel data for mips, starting from FirstMipToLoad, up to the last mip in the texture.
Public function Const int32 Returns the minimum number of mips that must be resident in memory (cannot be streamed).
Public function void

GetMipData ( int32 FirstMipToLoad,
void** OutMipData
)

 Get the PlatformData mip data starting with the specified mip index.
Public function Const int32  
Public function Const int32  
Public function Const int32

GetNumMipsAllowed ( bool bIgnoreMinResidency
)

 Calculates the maximum number of mips that will be in this texture after cooking (eg. after the "drop mip" lod bias is applied).
Public function Const int32  
Public function Const EPixelFormat

GetPixelFormat ( uint32 LayerIndex
)

  
Public function Const const FTexturePlatformData * Get the const derived data for this texture on this platform.
Public function FTexturePlatformData * Get the derived data for this texture on this platform.
Public function Const const TIndirectArray< FTexture2DMipMap > &  
Public function bool

GetResourceMemSettings ( int32 FirstMipIdx,
int32& OutSizeX,
int32& OutSizeY,
int32& OutNumMips,
uint32& OutTexCreateFlags
)

 Calculates and returns the corresponding ResourceMem parameters for this texture.
Public function Const int32 Trivial accessors.
Public function Const int32  
Public function bool

GetSourceArtCRC ( uint32& OutSourceCRC
)

 Get the CRC of the source art pixels.
Public function Const bool Returns true if the runtime texture has an alpha channel that is not completely white.
Public function bool

HasSameSourceArt ( UTexture2D* InTexture
)

 See if the source art of the two textures matches...
Public function Virtual Const bool Returns true if this virtual texture requests round-robin updates of the virtual texture pages.
Public function Virtual Const bool Returns true if this virtual texture uses a single physical space all of its texture layers.
Public function Virtual void Update the offset for mip map lod bias. This is added to any existing mip bias values.
Public function void Set the derived data for this texture on this platform.
Public function void Temporarily disable streaming so we update subregions of this texture without streaming clobbering it.
Public function void

UpdateTextureRegions ( int32 MipIndex,
uint32 NumRegions,
const FUpdateTextureRegion2D* Regions,
uint32 SrcPitch,
uint32 SrcBpp,
uint8* SrcData,
TFunction< void(uint8*SrcData, const FUpdateTextureRegion2D*Regions)> DataCleanupFunc
)

 Asynchronously update a set of regions of a texture with new data.

Overridden from UTexture

  Type Name Description
Public function Virtual Const bool Returns true if the Downscale and DownscaleOptions properties should be editable in the UI.
Public function Virtual Const uint32 Calculates the size of this texture if it had MipCount miplevels streamed in.
Public function Virtual FTextureResource * Implemented by subclasses to create a new resource for the texture.
Public function Virtual float

GetAverageBrightness ( bool bIgnoreTrueBlack,
bool bUseGrayscale
)

 Gets the average brightness of the texture (in linear space)
Public function Virtual TMap< FString, FTexturePlatformData * > *  
Public function Virtual Const EMaterialValueType  
Public function Virtual FTexturePlatformData ** Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data.
Public function Virtual Const uint32  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const TextureAddress  
Public function Virtual Const TextureAddress  
Public function Virtual Const ETextureClass Get Texture Class
Public function Virtual Const bool Returns if the texture is actually being rendered using virtual texturing right now.
Public function Virtual Const bool Returns true if the current texture is a default placeholder because compilation is still ongoing.
Public function Virtual void Creates a new resource for the texture, and updates any cached references to the resource.

Overridden from UStreamableRenderAsset

  Type Name Description
Public function Virtual Const int32  
Public function Virtual bool

StreamIn ( int32 NewMipCount,
bool bHighPrio
)

 Loads mips from disk to memory. Only usable if the asset is streamable.
Public function Virtual bool

StreamOut ( int32 NewMipCount
)

 Unload some mips from memory. Only usable if the asset is streamable.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const void 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
Public function Virtual FString

GetDesc ()

 Return a one line description of an object for viewing in the thumbnail view of the generic browser
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Returns the size of the object/ resource for display to artists/ LDs in the Editor.
Public function Virtual Const bool Called before calling PostLoad() in FAsyncPackage::PostLoadObjects().
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after an editor or undo operation is formed on texture
Public function Virtual void Called in response to the linker changing, this can only happen in the editor
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void

PreSave ( const ITargetPlatform* TargetPlatform
)

  
Public function Virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.