1. Epic GamesDeveloper
  3. UTexture

UTexture

API > API/Runtime > API/Runtime/Engine

   
Name UTexture
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Engine/Texture.h
Include Path #include "Engine/Texture.h"

Syntax

UCLASS (Abstract, MinimalAPI, BlueprintType)  
class UTexture :  
    public UStreamableRenderAsset ,  
    public IInterface_AssetUserData ,  
    public IInterface_AsyncCompilation

Inheritance Hierarchy

Implements Interfaces

Derived Classes

UTexture derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UTexture ( const FObjectInitializer& ObjectInitializer
)

   Engine/Texture.h  

UTexture ( FVTableHelper& Helper
)

   Engine/Texture.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UTexture()

   Engine/Texture.h  

Enums

Public

Name Remarks
EUpdateResourceFlags  

Protected

Name Remarks
ENotifyMaterialsEffectOnShaders  

Typedefs

Name Type Remarks Include Path
FOnTextureSaved TMulticastDelegate_OneParam< void, class UTexture * > Delegate type for texture save events ( Params: UTexture* TextureToSave ) Engine/Texture.h

Constants

Name Type Remarks Include Path
GMinTextureResidentMipCount int32 The minimum number of mips that must be resident in memory (cannot be streamed). Engine/Texture.h
PreSaveEvent FOnTextureSaved Triggered before a texture is being saved Engine/Texture.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AdjustBrightness float Static texture brightness adjustment (scales HSV value.) (Non-destructive; Requires texture source art to be available.) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(DisplayName="Brightness")
AdjustBrightnessCurve float Static texture curve adjustment (raises HSV value to the specified power.) (Non-destructive; Requires texture source art to be available.) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(DisplayName="Brightness Curve")
AdjustHue float Static texture hue adjustment (0 - 360) (offsets HSV hue by value in degrees.) (Non-destructive; Requires texture source art to be available.) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(DisplayName="Hue", ClampMin="0.0", ClampMax="360.0")
AdjustMaxAlpha float Remaps the alpha to the specified min/max range, defines the new value of 1 (Non-destructive; Requires texture source art to be available.) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(DisplayName="Max Alpha")
AdjustMinAlpha float Remaps the alpha to the specified min/max range, defines the new value of 0 (Non-destructive; Requires texture source art to be available.) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(DisplayName="Min Alpha")
AdjustRGBCurve float Static texture RGB curve adjustment (raises linear-space RGB color to the specified power.) (Non-destructive; Requires texture source art to be available.) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(DisplayName="RGBCurve")
AdjustSaturation float Static texture saturation adjustment (scales HSV saturation.) (Non-destructive; Requires texture source art to be available.) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(DisplayName="Saturation")
AdjustVibrance float Static texture "vibrance" adjustment (0 - 1) (HSV saturation algorithm adjustment.) (Non-destructive; Requires texture source art to be available.) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(DisplayName="Vibrance", ClampMin="0.0", ClampMax="1.0")
AlphaCoverageThresholds FVector4 Alpha values per channel to compare to when preserving alpha coverage. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(ClampMin="0", ClampMax="1.0", EditCondition="bDoScaleMipsForAlphaCoverage")
  • AdvancedDisplay
AssetImportData TObjectPtr< class UAssetImportData >   Engine/Texture.h
  • VisibleAnywhere
  • Instanced
  • Category=ImportSettings
Availability ETextureAvailability Whether the texture will be encoded to a gpu format and uploaded to the graphics card, or kept on the CPU for access by gamecode / blueprint. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(DisplayName="Availability")
  • AssetRegistrySearchable
bChromaKeyTexture bool Whether to chroma key the image, replacing any pixels that match ChromaKeyColor with transparent black Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
bCustomPropertiesImported uint8 Indicates ImportCustomProperties has been called (set in ImportCustomProperties, unset in the subsequent PostEditChange) Engine/Texture.h  
bDoScaleMipsForAlphaCoverage bool Whether mip RGBA should be scaled to preserve the number of pixels with Value >= AlphaCoverageThresholds. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • AdvancedDisplay
bFlipGreenChannel uint32 When true the texture's green channel will be inverted. This is useful for some normal maps. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • AdvancedDisplay
bIsImporting uint8 Indicates we're currently importing the object (set in PostEditImport, unset in the subsequent PostEditChange) Engine/Texture.h  
bNormalizeNormals uint8 Normalize colors in Normal Maps after mip generation for better and sharper quality; recommended on if not required to match legacy behavior. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(DisplayName="Normalize after making mips", EditCondition="CompressionSettings==1")
  • AdvancedDisplay
bNoTiling uint8 If true, the RHI texture will be created using TexCreate_NoTiling Engine/Texture.h  
bNotOfflineProcessed uint8 If true, the RHI texture will be created without TexCreate_OfflineProcessed. Engine/Texture.h
  • Transient
bOodlePreserveExtremes bool If set to true, then Oodle encoder preserves 0 and 255 (0.0 and 1.0) values exactly in alpha channel for BC3/BC7 and in all channels for BC4/BC5. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compression
  • Meta=(DisplayName="Preserve Extremes When Compressing With Oodle")
  • AdvancedDisplay
bPadWithBorderColor bool If set to true, texture padding will be performed using colors of the border pixels. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(EditCondition="PowerOfTwoMode == ETexturePowerOfTwoSetting::PadToPowerOfTwo || PowerOfTwoMode == ETexturePowerOfTwoSetting::PadToSquarePowerOfTwo", EditConditionHides)
bPreserveBorder uint32 When true the texture's border will be preserved during mipmap generation. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=LevelOfDetail
  • AdvancedDisplay
bUseLegacyGamma uint8 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. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(DisplayName="sRGB Use Legacy Gamma", EditCondition="SRGB")
  • AdvancedDisplay
bUseNewMipFilter bool For GUI hover text : Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(DisplayName="Use Improved Image Processing")
  • AdvancedDisplay
bUseVirtualTextureStreamingPriority uint32 Override the virtual texture streaming priority set on this texture by the texture LOD group. Engine/Texture.h
  • EditAnywhere
  • Category=LevelOfDetail
  • AdvancedDisplay
  • Meta=(EditCondition="VirtualTextureStreaming", InlineEditConditionToggle)
ChromaKeyColor FColor The color that will be replaced with transparent black if chroma keying is enabled Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(EditCondition="bChromaKeyTexture")
ChromaKeyThreshold float 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) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Adjustments
  • Meta=(EditCondition="bChromaKeyTexture", ClampMin="0")
CompositePower float 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 Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compositing
  • AdvancedDisplay
CompositeTexture TObjectPtr< class UTexture > Can be defined to modify the roughness based on the normal map variation (mostly from mip maps). Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compositing
  • Meta=(AllowPrivateAccess, RequiredAssetDataTags="IsSourceValid=True")
  • Setter=SetCompositeTexture
  • Getter=GetCompositeTexture
CompositeTextureMode TEnumAsByte< enum ECompositeTextureMode > Defines how the CompositeTexture is applied, e.g. CTM_RoughnessFromNormalAlpha Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compositing
  • AdvancedDisplay
CompressFinal uint32 If enabled, compress with Final quality during this Editor session. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Transient
  • SkipSerialization
  • Category=Compression
  • Meta=(NoResetToDefault)
  • Meta=(DisplayName="Editor Show Final Encode")
CompressionCacheId FGuid Change this optional ID to force the texture to be recompressed by changing its cache key. Engine/Texture.h
  • EditAnywhere
  • Category=Compression
  • Meta=(NoResetToDefault)
  • Meta=(DisplayName="Compression Cache ID")
  • AdvancedDisplay
CompressionForceAlpha uint32 If true, force alpha channel in output format when possible, eg. for AutoDXT BC1/BC3 choice Engine/Texture.h  
CompressionNoAlpha uint32 If enabled, the texture's alpha channel will be forced to opaque for any compressed texture output format. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compression
  • Meta=(DisplayName="Compress Without Alpha")
CompressionNone uint32 If true, force the texture to be uncompressed no matter the format. Engine/Texture.h  
CompressionQuality TEnumAsByte< enum ETextureCompressionQuality > The compression quality for generated ASTC textures (i.e. mobile platform textures). Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compression
  • Meta=(DisplayName="ASTC Compression Quality")
  • AdvancedDisplay
CompressionSettings TEnumAsByte< enum TextureCompressionSettings > Compression settings to use when building the texture. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compression
  • AssetRegistrySearchable
CompressionYCoCg uint8 If true the texture stores YCoCg. Engine/Texture.h  
CookPlatformTilingSettings TEnumAsByte< enum TextureCookPlatformTilingSettings > 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. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compression
  • AdvancedDisplay
DeferCompression uint32 If enabled, defer compression of the texture until save or manually compressed in the texture editor. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Transient
  • SkipSerialization
  • Category=Compression
  • Meta=(NoResetToDefault)
  • Meta=(DisplayName="Editor Defer Compression")
DidSerializeStreamingMipsForPlatform TMap< FString, bool > Used to record texture streamable state when cooking. Engine/Texture.h  
Downscale FPerPlatformFloat Downscale source texture, applied only to 2d textures without mips < 1.0 - use scale value from texture group 1.0 - do not scale texture Engine/Texture.h
  • EditAnywhere
  • Category=LevelOfDetail
  • AdvancedDisplay
  • Meta=(ClampMin="0.0", ClampMax="8.0", EditCondition=AreDownscalePropertiesEditable)
DownscaleOptions ETextureDownscaleOptions Texture downscaling options Engine/Texture.h
  • EditAnywhere
  • Category=LevelOfDetail
  • AdvancedDisplay
  • Meta=(EditCondition=AreDownscalePropertiesEditable)
Filter TEnumAsByte< enum TextureFilter > The texture filtering mode to use when sampling this texture. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • AssetRegistrySearchable
  • AdvancedDisplay
LayerFormatSettings TArray< FTextureFormatSettings > 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 Engine/Texture.h  
LevelIndex int32 Level scope index of this texture. Engine/Texture.h
  • Transient
  • DuplicateTransient
  • NonTransactional
LoadedMainStreamObjectVersion int Store the FUE5MainStreamObjectVersion of the Texture uasset loaded for debugging (== LatestVersion if not loaded) Engine/Texture.h  
LODBias int32 A bias to the index of the top mip level to use. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=LevelOfDetail
  • Meta=(DisplayName="LOD Bias")
  • AssetRegistrySearchable
LODGroup TEnumAsByte< enum TextureGroup > Texture group this texture belongs to Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=LevelOfDetail
  • Meta=(DisplayName="Texture Group")
  • AssetRegistrySearchable
LossyCompressionAmount TEnumAsByte< ETextureLossyCompressionAmount > How aggressively should any relevant lossy compression be applied. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compression
  • AdvancedDisplay
MaxTextureSize int32 The maximum resolution for generated textures. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compression
  • Meta=(DisplayName="Maximum Texture Size", ClampMin="0.0")
  • AdvancedDisplay
MipGenSettings TEnumAsByte< enum TextureMipGenSettings > Per asset specific setting to define the mip-map generation properties like sharpening and kernel size. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=LevelOfDetail
MipLoadOptions ETextureMipLoadOptions The texture mip load options. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • AssetRegistrySearchable
  • AdvancedDisplay
OodleTextureSdkVersion FName Oodle Texture SDK Version to encode with. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Compression
  • AdvancedDisplay
  • Meta=(NoResetToDefault)
OverrideRunningPlatformName FName Override the platform to cache for, instead of using "running plaform". NAME_None to use default editor platform. Engine/Texture.h  
PaddingColor FColor The color used to pad the texture out if it is padded due to PowerOfTwoMode Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(EditCondition="(PowerOfTwoMode == ETexturePowerOfTwoSetting::PadToPowerOfTwo || PowerOfTwoMode == ETexturePowerOfTwoSetting::PadToSquarePowerOfTwo) && !bPadWithBorderColor", EditConditionHides)
PowerOfTwoMode TEnumAsByte< enum ETexturePowerOfTwoSetting::Type > How to pad the texture to a power of 2 size (if necessary) Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(DisplayName="Padding and Resizing")
ReleaseFence FRenderCommandFence Release fence to know when resources have been freed on the rendering thread. Engine/Texture.h  
ResizeDuringBuildX int32 Width of the resized texture when using "Resize To Specific Resolution" padding and resizing option. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(EditCondition="PowerOfTwoMode == ETexturePowerOfTwoSetting::ResizeToSpecificResolution", EditConditionHides)
ResizeDuringBuildY int32 Width of the resized texture when using "Resize To Specific Resolution" padding and resizing option. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(EditCondition="PowerOfTwoMode == ETexturePowerOfTwoSetting::ResizeToSpecificResolution", EditConditionHides)
Source FTextureSource Dynamic textures will have ! Source.IsValid() ; Also in UEFN , Textures from the cooked-only texture library. Engine/Texture.h  
SourceColorSettings FTextureSourceColorSettings Texture color management settings: source encoding and color space. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • AdvancedDisplay
SRGB uint8 Whether Texture and its source are in SRGB Gamma color space. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • Meta=(DisplayName="sRGB")
  • AssetRegistrySearchable
TextureEditorCustomEncoding TWeakPtr< class FTextureEditorCustomEncode > 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. Engine/Texture.h  
TextureReference FTextureReference & Stable RHI texture reference that refers to the current RHI texture. Engine/Texture.h  
VirtualTexturePrefetchMips uint8 The number of mips that a virtual texture can stream using the traditional CPU texture streaming system. Engine/Texture.h
  • EditAnywhere
  • Category=Texture
  • AdvancedDisplay
  • Meta=(EditCondition="VirtualTextureStreaming")
VirtualTextureStreaming uint8 Is this texture streamed in using VT Engine/Texture.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Texture
  • AssetRegistrySearchable
  • AdvancedDisplay
VirtualTextureStreamingPriority EVTProducerPriority Priority to use when using virtual texture streaming for this texture. Engine/Texture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Texture
  • AdvancedDisplay
  • Meta=(EditCondition="bUseVirtualTextureStreamingPriority")

Protected

Name Type Remarks Include Path Unreal Specifiers
bAsyncResourceReleaseHasBeenStarted uint8 Whether the async resource release process has already been kicked off or not Engine/Texture.h
  • Transient
KnownCompositeTexture UTexture * Used to track down when CompositeTexture has been modified for notification purpose. Engine/Texture.h  
LightingGuid FGuid Unique ID for this material, used for caching during distributed lighting Engine/Texture.h  
PrivateResource FTextureResource * The texture's resource, can be NULL Engine/Texture.h  
PrivateResourceRenderThread FTextureResource * Value updated and returned by the render-thread to allow fenceless update from the game-thread without causing potential crash in the render thread. Engine/Texture.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AreDownscalePropertiesEditable()

 This function is used to control access to the Downscale and DownscaleOptions properties from the Texture Editor UI in order to make it more clear to the user whether these properties will or will not be used when building the texture. Engine/Texture.h  

void BeginCachePlatformData()

 Begins caching platform data in the background. Engine/Texture.h  

virtual void BlockOnAnyAsyncBuild ()

 If texture is currently in async build action or queue, block until it is done note: Modify() and PreEditChange() do this. Engine/Texture.h  
Get the dimensions of the largest mip of the texture when built, accounting for LODBias and other constraints Returns the 3d size when built for the current platform. Engine/Texture.h
  • BlueprintCallable
  • Meta=(DisplayName="GetBuiltTextureSize")
  • Category="Rendering|Texture"
Gets the memory size of the texture, in bytes. Engine/Texture.h
  • BlueprintCallable
  • Meta=(DisplayName="GetMemorySize")
  • Category="Rendering|Texture"

void Blueprint_GetTextureSourceDiskAndMemorySize ( int64& OutDiskSize,
int64& OutMemorySize
) const

 Gets the memory size of the texture source top mip, in bytes, and the size on disk of the asset, which may be compressed. Engine/Texture.h
  • BlueprintCallable
  • BlueprintPure=false
  • Meta=(DisplayName="GetTextureSourceDiskAndMemorySize")
  • Category="Rendering|Texture"

bool Blueprint_GetTextureSourceIdString ( FString& OutTextureSourceId
)

 Return the ID for the texture source. Engine/Texture.h
  • BlueprintCallable
  • Meta=(DisplayName="GetTextureSourceIdString")
  • Category="Rendering|Texture"
Creates a Guid for the texture based on the current texture values. Engine/Texture.h  

FGuid BuildLightingGuidFromHash()

 Helper for subclasses that want to implement BuildLightingGuid from a deterministic hash of the texture. Engine/Texture.h  

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

 Caches platform data for the texture. Engine/Texture.h  

virtual uint32 CalcTextureMemorySizeEnum ( ETextureMipCount Enum
) const

 Calculates the size of this texture if it had MipCount miplevels streamed in. Engine/Texture.h  

int32 CalculateLODBias ( bool bWithCinematicMipBias
) const

 Calculate the combined LOD bias based on texture LOD group and LOD bias. Engine/Texture.h  

bool CanBuildPlatformData ( const ITargetPlatformSettings* TargetPlatform
) const

 Returns if it is possible to build this texture for a given TargetPlatform (or any). Engine/Texture.h  

void CleanupCachedRunningPlatformData()

   Engine/Texture.h  

bool ComputeTextureSourceChannelMinMax ( FLinearColor& OutColorMin,
FLinearColor& OutColorMax
) const

 Scan the texture source pixels to compute the min & max values of the RGBA channels. Engine/Texture.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="Rendering|Texture"

virtual FTextureResource * CreateResource()

 Implemented by subclasses to create a new resource for the texture. Engine/Texture.h  

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

 Downsize the 2D Image with the build settings for the texture until all dimensions are <= TargetSize. Engine/Texture.h  
Blocks on async cache tasks and prepares platform data for use. Engine/Texture.h  
Forces platform data to be rebuilt. Engine/Texture.h  

virtual float GetAverageBrightness ( bool bIgnoreTrueBlack,
bool bUseGrayscale
)

 Gets the average brightness of the texture (in linear space) Engine/Texture.h  

int64 GetBuildRequiredMemory()

 Get an estimate of the peak amount of memory required to build this texture. Engine/Texture.h  

void GetBuiltTextureSize ( const ITargetPlatformSettings* TargetPlatformSettings,
const ITargetPlatformControls* TargetPlatformControls,
int32& OutSizeX,
int32& OutSizeY,
int32& OutSizeZ
) const

   Engine/Texture.h  

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

 Get the dimensions of the largest mip of the texture when built for the target platform accounting for LODBias and other constraints Engine/Texture.h  

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

   Engine/Texture.h  

void GetBuiltTextureSize ( const ITargetPlatformSettings* TargetPlatformSettings,
const ITargetPlatformControls* TargetPlatformControls,
int32& OutSizeX,
int32& OutSizeY
) const

   Engine/Texture.h  

UTexture * GetCompositeTexture()

   Engine/Texture.h  

virtual TMap< FString, FTexturePlatformData * > * GetCookedPlatformData()

   Engine/Texture.h  

void GetDefaultFormatSettings ( FTextureFormatSettings& OutSettings
) const

   Engine/Texture.h  

ETextureEncodeSpeed GetDesiredEncodeSpeed()

   Engine/Texture.h  

virtual FGuid GetExternalTextureGuid()

 Access the GUID which defines this texture's resources externally through FExternalTextureRegistry Engine/Texture.h  

EGammaSpace GetGammaSpace()

   Engine/Texture.h  

void GetLayerFormatSettings ( int32 LayerIndex,
FTextureFormatSettings& OutSettings
) const

 Gets settings used to choose format for the given layer Engine/Texture.h  

const FGuid & GetLightingGuid()

 Returns a unique identifier for this texture. Used by the lighting build and texture streamer. Engine/Texture.h  

virtual EMaterialValueType GetMaterialType()

   Engine/Texture.h  

virtual uint32 GetMaximumDimension()

 Return maximum dimension for this texture type (2d/cube/vol) in the current RHI use GetMaximumDimensionOfNonVT for platform-independent max dim Engine/Texture.h  

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

 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 Engine/Texture.h  
Get the const texture's resource, can be NULL Engine/Texture.h  
Get the texture's resource, can be NULL Engine/Texture.h  

virtual FTexturePlatformData ** GetRunningPlatformData()

 Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data. Engine/Texture.h  

virtual uint32 GetSurfaceArraySize()

   Engine/Texture.h  

virtual float GetSurfaceDepth()

   Engine/Texture.h  

virtual float GetSurfaceHeight()

   Engine/Texture.h  

virtual float GetSurfaceWidth()

   Engine/Texture.h  

void GetTargetPlatformBuildSettings ( const ITargetPlatform* TargetPlatform,
TArray< TArray< FTextureBuildSettings > >& OutSettingsPerFormatPerLayer
) const

   Engine/Texture.h  

virtual TextureAddress GetTextureAddressX()

   Engine/Texture.h  

virtual TextureAddress GetTextureAddressY()

   Engine/Texture.h  

virtual TextureAddress GetTextureAddressZ()

   Engine/Texture.h  

virtual ETextureClass GetTextureClass()

 Get Texture Class Engine/Texture.h  
Returns the type of streaming the texture is currently using on the current platform. Engine/Texture.h
  • BlueprintCallable
  • Category=Texture

virtual void GetVirtualTextureBuildSettings ( FVirtualTextureBuildSettings& OutSettings
) const

 Returns the virtual texture build settings. Engine/Texture.h  

bool HasHDRSource ( int32 LayerIndex
) const

 Checks whether this texture has a high dynamic range (HDR) source. Engine/Texture.h  

bool IsAsyncCacheComplete()

 Returns true if all async caching has completed. Engine/Texture.h  

bool IsCandidateForTextureStreamingOnPlatformDuringCook ( const ITargetPlatform* InTargetPlatform
) const

 Called by ULevel::MarkNoStreamableTexturesPrimitiveComponents when cooking level. Engine/Texture.h  

bool IsCookPlatformTilingDisabled ( const ITargetPlatformSettings* TargetPlatformSettings
) const

 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 Engine/Texture.h  

bool IsCookPlatformTilingDisabled ( const ITargetPlatform* TargetPlatform
) const

 Legacy function to support the old API, will call IsCookPlatformTilingDisabled with ITargetPlatformSettings Engine/Texture.h  

virtual bool IsCurrentlyVirtualTextured ()

 Returns if the texture is actually being rendered using virtual texturing right now. Engine/Texture.h  

virtual bool IsDefaultTexture()

 Returns true if the current texture is a default placeholder because compilation is still ongoing. Engine/Texture.h  

bool IsNormalMap()

   Engine/Texture.h  
Do the Texture properties make it a possible candidate for streaming. Engine/Texture.h  

bool IsUncompressed()

   Engine/Texture.h  
Marks platform data as transient. Engine/Texture.h  

void ReleaseResource()

 Resets the resource for the texture. Engine/Texture.h  
Returns true if this Texture cannot be built unless it has VT enabled. Engine/Texture.h  

void SerializeCookedPlatformData ( FArchive& Ar,
const bool bSerializeMipData
)

 Serializes cooked platform data. Engine/Texture.h  

void SetCompositeTexture ( UTexture* InCompositeTexture
)

   Engine/Texture.h  
Generates a deterministic GUID for the texture based on the full name of the object. Engine/Texture.h  

void SetLayerFormatSettings ( int32 LayerIndex,
const FTextureFormatSettings& InSettings
)

   Engine/Texture.h  

void SetLightingGuid ( const FGuid& Guid
)

   Engine/Texture.h  

void SetLightingGuid ()

 Assigns a new GUID to a texture. Engine/Texture.h  
Set new default settings that are desired for textures. Engine/Texture.h  

void SetResource ( FTextureResource* Resource
)

 Set texture's resource, can be NULL Engine/Texture.h  

void SetVirtualTextureStreaming ( bool bVirtualTextureStreaming
)

   Engine/Texture.h
  • BlueprintCallable
  • Category=Texture

void UpdateCachedLODBias()

 Cache the combined LOD bias based on texture LOD group and LOD bias. Engine/Texture.h  

virtual void UpdateOodleTextureSdkVersionToLatest ( bool bDoPrePostEditChangeIfChanging
)

 Change the Oodle Texture Sdk Version used to encode this texture to latest. Engine/Texture.h  

virtual void UpdateResource ()

 Creates a new resource for the texture, and updates any cached references to the resource. Engine/Texture.h  
Creates a new resource for the texture, and updates any cached references to the resource. Engine/Texture.h  

virtual void ValidateSettingsAfterImportOrEdit ( bool* pRequiresNotifyMaterials
)

 Ensure settings are valid after import or edit; this is called by PostEditChange. Engine/Texture.h  

Overridden from UStreamableRenderAsset

Name Remarks Include Path Unreal Specifiers

virtual bool DoesMipDataExist ( const int32 MipIndex
) const

   Engine/Texture.h  

virtual int32 GetCachedLODBias ()

 Returns the combined LOD bias based on texture LOD group and LOD bias. Engine/Texture.h  
Get the per-asset last render time. Engine/Texture.h  

virtual int32 GetLODGroupForStreaming()

 Get an integer representation of the LOD group Engine/Texture.h  

virtual FIoFilenameHash GetMipIoFilenameHash ( const int32 MipIndex
) const

   Engine/Texture.h  

virtual EStreamableRenderAssetType GetRenderAssetType()

   Engine/Texture.h  

virtual bool HasPendingLODTransition()

   Engine/Texture.h  

virtual bool HasPendingRenderResourceInitialization()

 Also returns false if the render resource is non existent, to prevent stalling on an event that will never complete. Engine/Texture.h  
Invalidates per-asset last render time. Engine/Texture.h  

virtual bool ShouldMipLevelsBeForcedResident()

 Returns whether miplevels should be forced resident. Engine/Texture.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

 Begins caching platform data in the background for the platform requested Engine/Texture.h  

virtual void BeginDestroy()

   Engine/Texture.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Engine/Texture.h  

virtual void ClearAllCachedCookedPlatformData()

 Clear all cached cooked platform data Engine/Texture.h  

virtual void ClearCachedCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

 Clears cached cooked platform data for specific platform Engine/Texture.h  

virtual void ExportCustomProperties ( FOutputDevice& Out,
uint32 Indent
)

   Engine/Texture.h  

virtual void FinishDestroy()

   Engine/Texture.h  

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   Engine/Texture.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   Engine/Texture.h  

virtual void ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

   Engine/Texture.h  

virtual bool IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetPlatform
)

 Have we finished loading all the cooked platform data for the given platform. Engine/Texture.h  

virtual bool IsPostLoadThreadSafe()

   Engine/Texture.h  

virtual bool IsReadyForFinishDestroy()

   Engine/Texture.h  

virtual bool Modify ( bool bAlwaysMarkDirty
)

   Engine/Texture.h  

virtual void PostCDOContruct()

   Engine/Texture.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Engine/Texture.h  

virtual void PostEditImport()

   Engine/Texture.h  

virtual void PostInitProperties()

   Engine/Texture.h  

virtual void PostLoad()

   Engine/Texture.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Engine/Texture.h  

virtual void Serialize ( FArchive& Ar
)

   Engine/Texture.h  

Overridden from IInterface_AssetUserData

Name Remarks Include Path Unreal Specifiers

virtual void AddAssetUserData ( UAssetUserData* InUserData
)

   Engine/Texture.h  

virtual const TArray< UAssetUserData * > * GetAssetUserDataArray()

   Engine/Texture.h  

virtual UAssetUserData * GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

 Returns an instance of the provided AssetUserData class if it's contained in the target asset. Engine/Texture.h  

virtual void RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

   Engine/Texture.h  

Overridden from IInterface_AsyncCompilation

Name Remarks Include Path Unreal Specifiers

virtual bool IsCompiling()

 Returns whether or not the asset is currently being compiled Engine/Texture.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BeginFinalReleaseResource()

   Engine/Texture.h  

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

 Calculates the render resource initial state, expected to be used in InitResource() for derived classes implementing streaming. Engine/Texture.h  

void NotifyMaterials ( const ENotifyMaterialsEffectOnShaders EffectOnShaders
)

 Notify any loaded material instances that the texture has changed. Engine/Texture.h  
Try to cancel any async tasks on PlatformData. Engine/Texture.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AppendToClassSchema ( FAppendToClassSchemaContext& Context
)

   Engine/Texture.h  
Cancels any pending texture streaming actions if possible. Engine/Texture.h  

static bool ForceUpdateTextureStreaming()

 Forces textures to recompute LOD settings and stream as needed. Engine/Texture.h  

static int32 GetMaximumDimensionOfNonVT()

 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 Engine/Texture.h  

static TextureMipGenSettings GetMipGenSettingsFromString ( const TCHAR* InStr,
bool bTextureGroup
)

   Engine/Texture.h  

static const TCHAR * GetMipGenSettingsString ( TextureMipGenSettings InEnum
)

   Engine/Texture.h  

static UEnum * GetPixelFormatEnum()

 Retrieves the pixel format enum for enum <-> string conversions. Engine/Texture.h  

static int32 GetStaticMinTextureResidentMipCount()

 Returns the minimum number of mips that must be resident in memory (cannot be streamed). Engine/Texture.h  

static const TCHAR * GetTextureGroupString ( TextureGroup InGroup
)

   Engine/Texture.h  

static bool IsVirtualTexturingEnabled ( const ITargetPlatformSettings* TargetPlatform
)

 Check the Project settings to see if VT is enabled. Optionally also checks the TargetPlatform. Engine/Texture.h  

static void SetMinTextureResidentMipCount ( int32 InMinTextureResidentMipCount
)

 Sets the minimum number of mips that must be resident in memory (cannot be streamed). Engine/Texture.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bDitherMipMapAlpha_DEPRECATED uint32 Removed. Engine/Texture.h  
SourceFilePath_DEPRECATED FString   Engine/Texture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page