1. Epic GamesDeveloper
  3. UTexture

UTexture

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

Inheritance Hierarchy

References

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

Syntax

class UTexture :  
    public UStreamableRenderAsset,  
    public IInterface_AssetUserData,  
    public IInterface_AsyncCompilation

Variables

  Type Name Description
Public variable float AdjustBrightness Static texture brightness adjustment (scales HSV value.) (Non-destructive; Requires texture source art to be available.)
Public variable float AdjustBrightnessCurve Static texture curve adjustment (raises HSV value to the specified power.) (Non-destructive; Requires texture source art to be available.)
Public variable float AdjustHue Static texture hue adjustment (0 - 360) (offsets HSV hue by value in degrees.) (Non-destructive; Requires texture source art to be available.)
Public variable float AdjustMaxAlpha Remaps the alpha to the specified min/max range, defines the new value of 1 (Non-destructive; Requires texture source art to be available.)
Public variable float AdjustMinAlpha Remaps the alpha to the specified min/max range, defines the new value of 0 (Non-destructive; Requires texture source art to be available.)
Public variable float AdjustRGBCurve Static texture RGB curve adjustment (raises linear-space RGB color to the specified power.) (Non-destructive; Requires texture source art to be available.)
Public variable float AdjustSaturation Static texture saturation adjustment (scales HSV saturation.) (Non-destructive; Requires texture source art to be available.)
Public variable float AdjustVibrance Static texture "vibrance" adjustment (0 - 1) (HSV saturation algorithm adjustment.) (Non-destructive; Requires texture source art to be available.)
Public variable FVector4 AlphaCoverageThresholds Alpha values per channel to compare to when preserving alpha coverage.
Public variable TObjectPtr< class UAssetImportData > AssetImportData  
Protected variable TArray< TObjectPtr< UAssetUserData > > AssetUserData Array of user data stored with the asset
Public variable bool bChromaKeyTexture Whether to chroma key the image, replacing any pixels that match ChromaKeyColor with transparent black
Public variable uint8: 1 bCustomPropertiesImported Indicates ImportCustomProperties has been called (set in ImportCustomProperties, unset in the subsequent PostEditChange)
Public variable bool bDoScaleMipsForAlphaCoverage Whether mip RGBA should be scaled to preserve the number of pixels with Value >= AlphaCoverageThresholds.
Public variable uint32: 1 bFlipGreenChannel When true the texture's green channel will be inverted. This is useful for some normal maps.
Public variable uint8: 1 bIsImporting Indicates we're currently importing the object (set in PostEditImport, unset in the subsequent PostEditChange)
Public variable uint8: 1 bNormalizeNormals Normalize colors in Normal Maps after mip generation for better and sharper quality; recommended on if not required to match legacy behavior.
Public variable uint8: 1 bNoTiling If true, the RHI texture will be created using TexCreate_NoTiling
Public variable uint8: 1 bNotOfflineProcessed If true, the RHI texture will be created without TexCreate_OfflineProcessed.
Public variable uint32: 1 bPreserveBorder When true the texture's border will be preserved during mipmap generation.
Public variable uint8: 1 bUseLegacyGamma A flag for using the simplified legacy gamma space e.g pow(color,1/2.2) for converting from FColor to FLinearColor, if we're doing sRGB.
Public variable bool bUseNewMipFilter Use faster mip generation filter, usually the same result but occasionally causes color shift in high contrast areas.
Public variable FColor ChromaKeyColor The color that will be replaced with transparent black if chroma keying is enabled
Public variable float ChromaKeyThreshold The threshold that components have to match for the texel to be considered equal to the ChromaKeyColor when chroma keying (<=, set to 0 to require a perfect exact match)
Public variable float CompositePower Default 1, high values result in a stronger effect e.g 1, 2, 4, 8 this is not a slider because the texture update would not be fast enough
Public variable TEnumAsByte< enum ECompositeTextureMode > CompositeTextureMode Defines how the CompositeTexture is applied, e.g. CTM_RoughnessFromNormalAlpha
Public variable uint32: 1 CompressFinal If enabled, compress with Final quality during this Editor session.
Public variable FGuid CompressionCacheId Change this optional ID to force the texture to be recompressed by changing its cache key.
Public variable uint32: 1 CompressionForceAlpha If true, force alpha channel in output format when possible, eg. for AutoDXT BC1/BC3 choice
Public variable uint32: 1 CompressionNoAlpha If enabled, the texture's alpha channel will be forced to opaque for any compressed texture output format.
Public variable uint32: 1 CompressionNone If true, force the texture to be uncompressed no matter the format.
Public variable TEnumAsByte< enum ETextureCompressionQuality > CompressionQuality The compression quality for generated ASTC textures (i.e. mobile platform textures).
Public variable TEnumAsByte< enum TextureCompressionSettings > CompressionSettings Compression settings to use when building the texture.
Public variable uint8: 1 CompressionYCoCg If true the texture stores YCoCg.
Public variable TEnumAsByte< enum TextureCookPlatformTilingSettings > CookPlatformTilingSettings If the platform supports it, tile the texture when cooking, or keep it linear and tile it when it's actually submitted to the GPU.
Public variable uint32: 1 DeferCompression If enabled, defer compression of the texture until save or manually compressed in the texture editor.
Public variable TMap< FString, bool > DidSerializeStreamingMipsForPlatform Used to record texture streamable state when cooking.
Public variable FPerPlatformFloat Downscale Downscale source texture, applied only to 2d textures without mips 0.0 - use scale value from texture group 1.0 - do not scale texture
Public variable ETextureDownscaleOptions DownscaleOptions Texture downscaling options
Public variable TEnumAsByte< enum TextureFilter > Filter The texture filtering mode to use when sampling this texture.
Public variable TArray< FTextureFormatSettings > LayerFormatSettings Array of settings used to control the format of given layer If this array doesn't include an entry for a given layer, values from UTexture will be used
Public variable int32 LevelIndex Level scope index of this texture.
Public variable int LoadedMainStreamObjectVersion Store the FUE5MainStreamObjectVersion of the Texture uasset loaded for debugging (== LatestVersion if not loaded)
Public variable int32 LODBias A bias to the index of the top mip level to use.
Public variable TEnumAsByte< enum TextureGroup > LODGroup Texture group this texture belongs to
Public variable TEnumAsByte< ETextureLossyCompressionAmount > LossyCompressionAmount How aggressively should any relevant lossy compression be applied.
Public variable int32 MaxTextureSize The maximum resolution for generated textures.
Public variable TEnumAsByte< enum TextureMipGenSettings > MipGenSettings Per asset specific setting to define the mip-map generation properties like sharpening and kernel size.
Public variable ETextureMipLoadOptions MipLoadOptions The texture mip load options.
Public variable FName OodleTextureSdkVersion Oodle Texture SDK Version to encode with.
Public variable FColor PaddingColor The color used to pad the texture out if it is resized due to PowerOfTwoMode
Public variable TEnumAsByte< enum ETexturePowerOfTwoSetting::Type > PowerOfTwoMode How to pad the texture to a power of 2 size (if necessary)
Public variable FRenderCommandFence ReleaseFence Release fence to know when resources have been freed on the rendering thread.
Public variable FTextureSource Source Dynamic textures will have ! Source.IsValid() ; Also in UEFN , Textures from the cooked-only texture library.
Public variable FTextureSourceColorSettings SourceColorSettings Texture color management settings: source encoding and color space.
Public variable uint8: 1 SRGB Whether Texture and its source are in SRGB Gamma color space.
Public variable TWeakPtr< class FTextureEditorCustomEncode > TextureEditorCustomEncoding When we are open in an asset editor, we have a pointer to a custom encoding object which can optionally cause us to do something other than Fast/Final encode settings.
Public variable FTextureReference & TextureReference Stable RHI texture reference that refers to the current RHI texture.
Public variable uint8: 1 VirtualTextureStreaming Is this texture streamed in using VT

Constructors

  Type Name Description
Public function  

UTexture ( const FObjectInitializer& ObjectInitializer
)

  
Public function  

UTexture ( FVTableHelper& Helper
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static void  
Public function void Begins caching platform data in the background.
Protected function void  
Public function Const int64 Gets the memory size of the texture, in bytes.
Public function Const void

Blueprint_GetTextureSourceDiskAndMemorySize ( int64& OutDiskSize,
int64& OutMemorySize
)

 Gets the memory size of the texture source top mip, in bytes, and the size on disk of the asset, which may be compressed.
Public function void

CachePlatformData ( bool bAsyncCache,
bool bAllowAsyncBuild,
bool bAllowAsyncLoading,
ITextureCompressorModule* Compressor
)

 Caches platform data for the texture.
Public function Virtual Const uint32

CalcTextureMemorySizeEnum ( ETextureMipCount Enum
)

 Calculates the size of this texture if it had MipCount miplevels streamed in.
Public function Const int32

CalculateLODBias ( bool bWithCinematicMipBias
)

 Calculate the combined LOD bias based on texture LOD group and LOD bias.
Public function Static void Cancels any pending texture streaming actions if possible.
Public function void  
Public function Const bool Scan the texture source pixels to compute the min & max values of the RGBA channels.
Public function Virtual FTextureResource * Implemented by subclasses to create a new resource for the texture.
Public function bool

DownsizeImageUsingTextureSettings ( const ITargetPlatform* TargetPlatform,
FImage& InOutImage,
int32 TargetSize,
int32 LayerIndex
)

 Downsize the 2D Image with the build setting of the texture.
Public function void Blocks on async cache tasks and prepares platform data for use.
Public function void

ForceRebuildPlatformData ( uint8 InEncodeSpeedOverride
)

 Forces platform data to be rebuilt.
Public function Static bool Forces textures to recompute LOD settings and stream as needed.
Public function Virtual float

GetAverageBrightness ( bool bIgnoreTrueBlack,
bool bUseGrayscale
)

 Gets the average brightness of the texture (in linear space)
Public function Const void

GetBuiltTextureSize ( const ITargetPlatform* TargetPlatform,
int32& OutSizeX,
int32& OutSizeY
)

 Get the dimensions of the largest mip of the texture when built for the target platform accounting for LODBias and other constraints
Public function Const UTexture *  
Public function Virtual TMap< FString, FTexturePlatformData * > *  
Public function Const void  
Public function Const ETextureEncodeSpeed  
Public function Virtual Const FGuid Access the GUID which defines this texture's resources externally through FExternalTextureRegistry
Public function Const EGammaSpace  
Public function Const void

GetLayerFormatSettings ( int32 LayerIndex,
FTextureFormatSettings& OutSettings
)

 Gets settings used to choose format for the given layer
Public function Const const FGuid & Returns a unique identifier for this texture. Used by the lighting build and texture streamer.
Public function Virtual Const EMaterialValueType  
Public function Virtual Const uint32 Return maximum dimension for this texture type (2d/cube/vol) in the current RHI use GetMaximumDimensionOfNonVT for platform-independent max dim
Public function Static int32 Get the largest allowed dimension of non-VT texture this is not for the current RHI (which may have a lower limit), this is for a Texture in general
Public function Static TextureMipGenSettings

GetMipGenSettingsFromString ( const TCHAR* InStr,
bool bTextureGroup
)

  
Public function Static const TCHAR *

GetMipGenSettingsString ( TextureMipGenSettings InEnum
)

  
Public function Static UEnum * Retrieves the pixel format enum for enum <-> string conversions.
Public function Const void

GetPlatformTextureFormatNamesWithPrefix ( const ITargetPlatform* TargetPlatform,
TArray< TArray< FName > >& OutFormats
)

 Get TextureFormatName with platform remaps and conditional prefix this is the entry point API for getting the final texture format name OutFormats will be resized to the number of sub-flavors of the platform (typically just 1) OutFormats[i] gets an array of format names, one per layer
Public function Const const FTextureResource * Get the const texture's resource, can be NULL
Public function FTextureResource * Get the texture's resource, can be NULL
Protected function Const FStreamableRenderResourceState

GetResourcePostInitState ( const FTexturePlatformData* PlatformData,
bool bAllowStreaming,
int32 MinRequestMipCount,
int32 MaxMipCount,
bool bSkipCanBeLoaded
)

 Calculates the render resource initial state, expected to be used in InitResource() for derived classes implementing streaming.
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 Static int32 Returns the minimum number of mips that must be resident in memory (cannot be streamed).
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 TextureAddress  
Public function Virtual Const ETextureClass Get Texture Class
Public function Static const TCHAR *

GetTextureGroupString ( TextureGroup InGroup
)

  
Public function Virtual Const void Returns the virtual texture build settings.
Public function Const bool

HasHDRSource ( int32 LayerIndex
)

 Checks whether this texture has a high dynamic range (HDR) source.
Public function Const bool Returns true if all async caching has completed.
Public function Const bool Called by ULevel::MarkNoStreamableTexturesPrimitiveComponents when cooking level.
Public function Const bool

IsCookPlatformTilingDisabled ( const ITargetPlatform* TargetPlatform
)

 Checks whether this texture should be tiled to a platform-specific format during cook, or whether the bNotOfflineProcessed flag should be set to true at runtime because it has not been tiled at cook
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 Const bool  
Public function Const bool Do the Texture properties make it a possible candidate for streaming.
Public function Const bool  
Public function void Marks platform data as transient.
Protected function void Notify any loaded material instances that the texture has changed.
Public function void Resets the resource for the texture.
Public function void

SerializeCookedPlatformData ( FArchive& Ar,
const bool bSerializeMipData
)

 Serializes cooked platform data.
Public function void

SetCompositeTexture ( UTexture* InCompositeTexture
)

  
Public function void Generates a deterministic GUID for the texture based on the full name of the object.
Public function void

SetLayerFormatSettings ( int32 LayerIndex,
const FTextureFormatSettings& InSettings
)

  
Public function void

SetLightingGuid ( const FGuid& Guid
)

  
Public function void Assigns a new GUID to a texture.
Public function Static void

SetMinTextureResidentMipCount ( int32 InMinTextureResidentMipCount
)

 Sets the minimum number of mips that must be resident in memory (cannot be streamed).
Public function void Set texture's resource, can be NULL
Protected function bool Try to cancel any async tasks on PlatformData.
Public function Virtual void

UpdateOodleTextureSdkVersionToLatest ( bool bDoPrePostEditChangeIfChanging
)

 Change the Oodle Texture Sdk Version used to encode this texture to latest.
Public function Virtual void Creates a new resource for the texture, and updates any cached references to the resource.
Public function Virtual void

ValidateSettingsAfterImportOrEdit ( bool* pRequiresNotifyMaterials
)

 Ensure settings are valid after import or edit; this is called by PostEditChange.

Overridden from UStreamableRenderAsset

  Type Name Description
Public function Virtual Const bool

DoesMipDataExist ( const int32 MipIndex
)

  
Public function Virtual Const int32 Returns the combined LOD bias based on texture LOD group and LOD bias.
Public function Virtual Const float Get the per-asset last render time.
Public function Virtual Const int32 Get an integer representation of the LOD group
Public function Virtual Const FIoFilenameHash

GetMipIoFilenameHash ( const int32 MipIndex
)

  
Public function Virtual Const EStreamableRenderAssetType  
Public function Virtual Const bool  
Public function Virtual Const bool Also returns false if the render resource is non existent, to prevent stalling on an event that will never complete.
Public function Virtual void Invalidates per-asset last render time.
Public function Virtual Const bool Returns whether miplevels should be forced resident.

Overridden from UObject

  Type Name Description
Public function Virtual void Begins caching platform data in the background for the platform requested
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void Clear all cached cooked platform data
Public function Virtual void Clears cached cooked platform data for specific platform
Public function Virtual void

ExportCustomProperties ( FOutputDevice& Out,
uint32 Indent
)

 Exports the property values for the specified object as text to the output device.
Public function Virtual void Called to finish destroying the object.
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 void

ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

 Exports the property values for the specified object as text to the output device.
Public function Virtual bool Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual bool

Modify ( bool bAlwaysMarkDirty
)

 Note that the object will be modified.
Public function Virtual void Called after the C++ constructor has run on the Class Default Object (CDO) for a class.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

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

Overridden from IInterface_AssetUserData

  Type Name Description
Public function Virtual void  
Public function Virtual Const const TArray< UAssetUserData * > *  
Public function Virtual UAssetUserData *  
Public function Virtual void  

Overridden from IInterface_AsyncCompilation

  Type Name Description
Public function Virtual Const bool Returns whether or not the asset is currently being compiled

Enums

  Type Name Description
Protected enum ENotifyMaterialsEffectOnShaders    

Typedefs

Name Description
FOnTextureSaved Delegate type for texture save events ( Params: UTexture* TextureToSave )

Constants

Name Description
GMinTextureResidentMipCount The minimum number of mips that must be resident in memory (cannot be streamed).
PreSaveEvent Triggered before a texture is being saved

Deprecated Variables

  Type Name Description
Public variable uint32: 1 bDitherMipMapAlpha_DEPRECATED Removed.
Public variable TObjectPtr< class UTexture > CompositeTexture Use GetCompositeTexture() and SetCompositeTexture() instead.
Public variable TFieldPtrAccessor< FTextureResource > Resource Use GetResource() / SetResource() accessors instead.
Public variable FString SourceFilePath_DEPRECATED  

Deprecated Functions

  Type Name Description
Public function Const int64 Use GetBuildRequiredMemoryEstimate instead
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

PreSave ( const ITargetPlatform* TargetPlatform
)

 Use version that takes FObjectPreSaveContext instead.
Public function void UpdateCachedLODBias does nothing, remove call

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.