UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UTexture Class Reference

#include <Texture.h>

+ Inheritance diagram for UTexture:

Public Types

enum class  EUpdateResourceFlags : uint32 { None =0 , ForceRebuild =0x1 , Synchronous =0x2 }
 
- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 

Public Member Functions

virtual bool AreDownscalePropertiesEditable () const
 
int64 Blueprint_GetMemorySize () const
 
void Blueprint_GetTextureSourceDiskAndMemorySize (int64 &OutDiskSize, int64 &OutMemorySize) const
 
bool ComputeTextureSourceChannelMinMax (FLinearColor &OutColorMin, FLinearColor &OutColorMax) const
 
bool Blueprint_GetTextureSourceIdString (FString &OutTextureSourceId)
 
ENGINE_API UTexture (FVTableHelper &Helper)
 
virtual ENGINE_API ~UTexture ()
 
ENGINE_API void SetResource (FTextureResource *Resource)
 
ENGINE_API FTextureResourceGetResource ()
 
ENGINE_API const FTextureResourceGetResource () const
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnTextureSaved, class UTexture *)
 
virtual ENGINE_API void ExportCustomProperties (FOutputDevice &Out, uint32 Indent) override
 
virtual ENGINE_API void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn) override
 
virtual ENGINE_API void PostEditImport () override
 
ENGINE_API void ReleaseResource ()
 
virtual void UpdateResource ()
 
virtual ENGINE_API void UpdateResourceWithParams (EUpdateResourceFlags InFlags)
 
void UpdateCachedLODBias ()
 
int32 GetCachedLODBias () const override
 
ENGINE_API int32 CalculateLODBias (bool bWithCinematicMipBias) const
 
virtual bool IsCurrentlyVirtualTextured () const
 
ENGINE_API ETextureStreamingMethod GetTextureStreamingMethod () const
 
virtual ENGINE_API void GetVirtualTextureBuildSettings (struct FVirtualTextureBuildSettings &OutSettings) const
 
virtual FTexturePlatformData ** GetRunningPlatformData ()
 
virtual TMap< FString, FTexturePlatformData * > * GetCookedPlatformData ()
 
void CleanupCachedRunningPlatformData ()
 
ENGINE_API void GetBuiltTextureSize (const ITargetPlatform *TargetPlatform, int32 &OutSizeX, int32 &OutSizeY, int32 &OutSizeZ) const
 
ENGINE_API void GetBuiltTextureSize (const class ITargetPlatformSettings *TargetPlatformSettings, const class ITargetPlatformControls *TargetPlatformControls, int32 &OutSizeX, int32 &OutSizeY, int32 &OutSizeZ) const
 
void GetBuiltTextureSize (const ITargetPlatform *TargetPlatform, int32 &OutSizeX, int32 &OutSizeY) const
 
void GetBuiltTextureSize (const class ITargetPlatformSettings *TargetPlatformSettings, const class ITargetPlatformControls *TargetPlatformControls, int32 &OutSizeX, int32 &OutSizeY) const
 
FVector3f Blueprint_GetBuiltTextureSize ()
 
ENGINE_API void SerializeCookedPlatformData (class FArchive &Ar, const bool bSerializeMipData=true)
 
virtual ENGINE_API void AddAssetUserData (UAssetUserData *InUserData) override
 
virtual ENGINE_API void RemoveUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API UAssetUserDataGetAssetUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API const TArray< UAssetUserData * > * GetAssetUserDataArray () const override
 
EGammaSpace GetGammaSpace () const
 
virtual TextureAddress GetTextureAddressX () const
 
virtual TextureAddress GetTextureAddressY () const
 
virtual TextureAddress GetTextureAddressZ () const
 
virtual FGuid GetExternalTextureGuid () const
 
virtual ENGINE_API void Serialize (FArchive &Ar) override
 
virtual ENGINE_API void PostInitProperties () override
 
virtual ENGINE_API void PostLoad () override
 
virtual ENGINE_API void PreSave (FObjectPreSaveContext ObjectSaveContext) override
 
virtual ENGINE_API void BeginDestroy () override
 
virtual ENGINE_API bool IsReadyForFinishDestroy () override
 
virtual ENGINE_API void FinishDestroy () override
 
virtual ENGINE_API void PostCDOContruct () override
 
virtual ENGINE_API bool IsPostLoadThreadSafe () const override
 
virtual int32 GetLODGroupForStreaming () const final override
 
virtual EStreamableRenderAssetType GetRenderAssetType () const final override
 
virtual ENGINE_API FIoFilenameHash GetMipIoFilenameHash (const int32 MipIndex) const final override
 
virtual ENGINE_API bool DoesMipDataExist (const int32 MipIndex) const final override
 
virtual ENGINE_API bool HasPendingRenderResourceInitialization () const final override
 
virtual ENGINE_API bool HasPendingLODTransition () const final override
 
virtual ENGINE_API void InvalidateLastRenderTimeForStreaming () final override
 
virtual ENGINE_API float GetLastRenderTimeForStreaming () const final override
 
virtual ENGINE_API bool ShouldMipLevelsBeForcedResident () const final override
 
virtual ENGINE_API float GetAverageBrightness (bool bIgnoreTrueBlack, bool bUseGrayscale)
 
bool HasHDRSource (int32 LayerIndex=0) const
 
bool IsNormalMap () const
 
bool IsUncompressed () const
 
ENGINE_API bool IsCookPlatformTilingDisabled (const ITargetPlatformSettings *TargetPlatformSettings) const
 
ENGINE_API bool IsCookPlatformTilingDisabled (const ITargetPlatform *TargetPlatform) const
 
virtual uint32 CalcTextureMemorySizeEnum (ETextureMipCount Enum) const
 
const FGuidGetLightingGuid () const
 
void SetLightingGuid ()
 
void SetLightingGuid (const FGuid &Guid)
 
ENGINE_API void SetDeterministicLightingGuid ()
 
bool IsPossibleToStream () const
 
- Public Member Functions inherited from UStreamableRenderAsset
virtual ENGINE_API ~UStreamableRenderAsset ()
 
virtual int32 CalcCumulativeLODSize (int32 NumLODs) const
 
ENGINE_API void CancelPendingStreamingRequest ()
 
ENGINE_API bool HasPendingInitOrStreaming (bool bWaitForLODTransition=false) const
 
bool IsPendingStreamingRequestLocked () const
 
virtual bool StreamOut (int32 NewMipCount)
 
virtual bool StreamIn (int32 NewMipCount, bool bHighPrio)
 
ENGINE_API void RegisterMipLevelChangeCallback (UPrimitiveComponent *Component, int32 LODIdx, float TimeoutSecs, bool bOnStreamIn, FLODStreamingCallback &&Callback)
 
ENGINE_API void RegisterMipLevelChangeCallback (UPrimitiveComponent *Component, float TimeoutStartSecs, FLODStreamingCallback &&CallbackStreamingStart, float TimeoutDoneSecs, FLODStreamingCallback &&CallbackStreamingDone)
 
ENGINE_API void RemoveMipLevelChangeCallback (UPrimitiveComponent *Component)
 
ENGINE_API void RemoveAllMipLevelChangeCallbacks ()
 
ENGINE_API void TickMipLevelChangeCallbacks (TArray< UStreamableRenderAsset * > *DeferredTickCBAssets)
 
ENGINE_API void SetForceMipLevelsToBeResident (float Seconds, int32 CinematicLODGroupMask=0)
 
const FStreamableRenderResourceStateGetStreamableResourceState () const
 
bool RenderResourceSupportsStreaming () const
 
bool IsStreamable () const
 
ENGINE_API void LinkStreaming ()
 
ENGINE_API void UnlinkStreaming ()
 
ENGINE_API bool IsFullyStreamedIn ()
 
int32 GetStreamingIndex () const
 
ENGINE_API void WaitForPendingInitOrStreaming (bool bWaitForLODTransition=false, bool bSendCompletionEvents=false)
 
ENGINE_API void WaitForStreaming (bool bWaitForLODTransition=false, bool bSendCompletionEvents=false)
 
void TickStreaming (bool bSendCompletionEvents=false, TArray< UStreamableRenderAsset * > *DeferredTickCBAssets=nullptr)
 
const FPerQualityLevelIntGetNoRefStreamingLODBias () const
 
void SetNoRefStreamingLODBias (FPerQualityLevelInt NewValue)
 
ENGINE_API int32 GetCurrentNoRefStreamingLODBias () const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Static Public Member Functions

static ENGINE_API bool IsVirtualTexturingEnabled (const ITargetPlatformSettings *TargetPlatform=nullptr)
 
static ENGINE_API void CancelPendingTextureStreaming ()
 
static ENGINE_API const TCHARGetTextureGroupString (TextureGroup InGroup)
 
static ENGINE_API const TCHARGetMipGenSettingsString (TextureMipGenSettings InEnum)
 
static ENGINE_API TextureMipGenSettings GetMipGenSettingsFromString (const TCHAR *InStr, bool bTextureGroup)
 
static ENGINE_API bool ForceUpdateTextureStreaming ()
 
static ENGINE_API class UEnumGetPixelFormatEnum ()
 
static int32 GetStaticMinTextureResidentMipCount ()
 
static void SetMinTextureResidentMipCount (int32 InMinTextureResidentMipCount)
 
static ENGINE_API int32 GetMaximumDimensionOfNonVT ()
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Public Attributes

int32 LevelIndex = INDEX_NONE
 
int32 LODBias
 
TEnumAsByte< enum TextureCompressionSettingsCompressionSettings
 
TEnumAsByte< enum TextureFilterFilter
 
ETextureMipLoadOptions MipLoadOptions
 
EVTProducerPriority VirtualTextureStreamingPriority
 
uint8 VirtualTexturePrefetchMips = 0
 
TEnumAsByte< enum TextureCookPlatformTilingSettingsCookPlatformTilingSettings
 
bool bOodlePreserveExtremes = false
 
TEnumAsByte< enum TextureGroupLODGroup
 
FPerPlatformFloat Downscale
 
ETextureDownscaleOptions DownscaleOptions
 
ETextureAvailability Availability
 
uint8 SRGB:1
 
uint8 bNoTiling:1
 
uint8 VirtualTextureStreaming: 1
 
uint32 bUseVirtualTextureStreamingPriority: 1
 
uint8 CompressionYCoCg: 1
 
uint8 bNotOfflineProcessed: 1
 
FTextureReferenceTextureReference
 
FRenderCommandFence ReleaseFence
 
virtual ETextureClass GetTextureClass () const PURE_VIRTUAL(UTexture
 
virtual class FTextureResourceCreateResource () PURE_VIRTUAL(UTexture
 
virtual EMaterialValueType GetMaterialType () const PURE_VIRTUAL(UTexture
 
virtual float GetSurfaceWidth () const PURE_VIRTUAL(UTexture
 
virtual float GetSurfaceHeight () const PURE_VIRTUAL(UTexture
 
virtual float GetSurfaceDepth () const PURE_VIRTUAL(UTexture
 
virtual uint32 GetSurfaceArraySize () const PURE_VIRTUAL(UTexture
 
- Public Attributes inherited from UStreamableRenderAsset
int32 NumCinematicMipLevels
 
uint8 NeverStream: 1
 
uint8 bGlobalForceMipLevelsToBeResident: 1
 
uint8 bHasStreamingUpdatePending: 1
 
uint8 bForceMiplevelsToBeResident: 1
 
uint8 bIgnoreStreamingMipBias: 1
 
uint8 bMarkAsEditorStreamingPool: 1
 

Static Public Attributes

static ENGINE_API FOnTextureSaved PreSaveEvent
 

Protected Member Functions

void BeginFinalReleaseResource ()
 
FStreamableRenderResourceState GetResourcePostInitState (const FTexturePlatformData *PlatformData, bool bAllowStreaming, int32 MinRequestMipCount=0, int32 MaxMipCount=0, bool bSkipCanBeLoaded=false) const
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Protected Attributes

TArray< TObjectPtr< UAssetUserData > > AssetUserData
 
- Protected Attributes inherited from UStreamableRenderAsset
TArray< FLODStreamingCallbackPayloadMipChangeCallbacks
 
TRefCountPtr< class FRenderAssetUpdatePendingUpdate
 
double ForceMipLevelsToBeResidentTimestamp
 
FPerQualityLevelInt NoRefStreamingLODBias
 
int32 StreamingIndex = INDEX_NONE
 
TSharedPtr< int32, ESPMode::ThreadSafeSimpleStreamableAssetManagerIndex = MakeShared<int32, ESPMode::ThreadSafe>(INDEX_NONE)
 
uint8 bUseCinematicMipLevels: 1
 
FStreamableRenderResourceState CachedSRRState
 

Static Protected Attributes

static ENGINE_API int32 GMinTextureResidentMipCount = NUM_INLINE_DERIVED_MIPS
 

Member Enumeration Documentation

◆ EUpdateResourceFlags

Enumerator
None 
ForceRebuild 
Synchronous 

Constructor & Destructor Documentation

◆ UTexture()

UTexture::UTexture ( FVTableHelper Helper)

◆ ~UTexture()

PRAGMA_DISABLE_DEPRECATION_WARNINGS UTexture::~UTexture ( )
virtual

Member Function Documentation

◆ AddAssetUserData()

void UTexture::AddAssetUserData ( UAssetUserData InUserData)
overridevirtual

Reimplemented from IInterface_AssetUserData.

◆ AreDownscalePropertiesEditable()

virtual bool UTexture::AreDownscalePropertiesEditable ( ) const
inlinevirtual

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.

◆ BeginDestroy()

void UTexture::BeginDestroy ( )
overridevirtual

Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

Reimplemented from UStreamableRenderAsset.

Reimplemented in UTexture2D, UMediaTexture, and UWebBrowserTexture.

◆ BeginFinalReleaseResource()

void UTexture::BeginFinalReleaseResource ( )
protected

◆ Blueprint_GetBuiltTextureSize()

FVector3f UTexture::Blueprint_GetBuiltTextureSize ( )

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. Does not cause texture to get built.

◆ Blueprint_GetMemorySize()

int64 UTexture::Blueprint_GetMemorySize ( ) const

Gets the memory size of the texture, in bytes. This is the size in GPU memory of the built platformdata, accounting for LODBias, etc. Returns zero for error.

◆ Blueprint_GetTextureSourceDiskAndMemorySize()

void UTexture::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. Uses texture source, not available in runtime games. Does not cause texture source to be loaded, queries cached values. Returns zero for error.

◆ Blueprint_GetTextureSourceIdString()

bool UTexture::Blueprint_GetTextureSourceIdString ( FString &  OutTextureSourceId)

Return the ID for the texture source. If the source isn't valid or editor data isn't available, returns false.

◆ CalcTextureMemorySizeEnum()

virtual uint32 UTexture::CalcTextureMemorySizeEnum ( ETextureMipCount  Enum) const
inlinevirtual

Calculates the size of this texture if it had MipCount miplevels streamed in. This is the size in GPU memory of the built platformdata, accounting for LODBias, etc.

Parameters
EnumWhich mips to calculate size for.
Returns
Total size of all specified mips, in bytes. Returns 0 for error.

Reimplemented in UTexture2D, UTexture2DArray, UTextureCube, UTextureCubeArray, UVolumeTexture, and UMediaTexture.

◆ CalculateLODBias()

int32 UTexture::CalculateLODBias ( bool  bWithCinematicMipBias) const

Calculate the combined LOD bias based on texture LOD group and LOD bias. CalculateLODBias(true) >= CalculateLODBias(false) CalculateLODBias(true) == CalculateLODBias(false) + NumCinematicMipLevels , except when a clamp was applied

Returns
LOD bias

◆ CancelPendingTextureStreaming()

void UTexture::CancelPendingTextureStreaming ( )
static

Cancels any pending texture streaming actions if possible. Returns when no more async loading requests are in flight.

◆ CleanupCachedRunningPlatformData()

void UTexture::CleanupCachedRunningPlatformData ( )

◆ ComputeTextureSourceChannelMinMax()

bool UTexture::ComputeTextureSourceChannelMinMax ( FLinearColor OutColorMin,
FLinearColor OutColorMax 
) const

Scan the texture source pixels to compute the min & max values of the RGBA channels. Uses texture source, not available in runtime games. Causes texture source data to be loaded, is computed by scanning pixels when called. Will set Min=Max=zero and return false on failure

◆ DECLARE_MULTICAST_DELEGATE_OneParam()

UTexture::DECLARE_MULTICAST_DELEGATE_OneParam ( FOnTextureSaved  ,
class UTexture  
)

delegate type for texture save events ( Params: UTexture* TextureToSave )

◆ DoesMipDataExist()

bool UTexture::DoesMipDataExist ( const int32  MipIndex) const
finaloverridevirtual

Reimplemented from UStreamableRenderAsset.

◆ ExportCustomProperties()

void UTexture::ExportCustomProperties ( FOutputDevice Out,
uint32  Indent 
)
overridevirtual

Exports the property values for the specified object as text to the output device. Override this if you need custom support for copy/paste.

Parameters
OutThe output device to send the exported text to
IndentNumber of spaces to prepend to each line of output
See also
ImportCustomProperties()

Reimplemented from UObject.

◆ FinishDestroy()

void UTexture::FinishDestroy ( )
overridevirtual

Called to finish destroying the object. After UObject::FinishDestroy is called, the object's memory should no longer be accessed.

Warning
Because properties are destroyed here, Super::FinishDestroy() should always be called at the end of your child class's FinishDestroy() method, rather than at the beginning.

Reimplemented from UObject.

◆ ForceUpdateTextureStreaming()

bool UTexture::ForceUpdateTextureStreaming ( )
static

Forces textures to recompute LOD settings and stream as needed.

Returns
true if the settings were applied, false if they couldn't be applied immediately.

◆ GetAssetUserDataArray()

const TArray< UAssetUserData * > * UTexture::GetAssetUserDataArray ( ) const
overridevirtual

Reimplemented from IInterface_AssetUserData.

◆ GetAssetUserDataOfClass()

UAssetUserData * UTexture::GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData InUserDataClass)
overridevirtual

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

Parameters
InUserDataClassUAssetUserData sub class to get
Returns
The instance of the UAssetUserData class contained, or null if it doesn't exist

Reimplemented from IInterface_AssetUserData.

◆ GetAverageBrightness()

float UTexture::GetAverageBrightness ( bool  bIgnoreTrueBlack,
bool  bUseGrayscale 
)
virtual

Gets the average brightness of the texture (in linear space)

Parameters
bIgnoreTrueBlackIf true, then pixels w/ 0,0,0 rgb values do not contribute.
bUseGrayscaleIf true, use gray scale else use the max color component.
Returns
float The average brightness of the texture

Reimplemented in UTexture2D.

◆ GetBuiltTextureSize() [1/4]

void UTexture::GetBuiltTextureSize ( const class ITargetPlatformSettings TargetPlatformSettings,
const class ITargetPlatformControls TargetPlatformControls,
int32 OutSizeX,
int32 OutSizeY 
) const
inline

◆ GetBuiltTextureSize() [2/4]

ENGINE_API void UTexture::GetBuiltTextureSize ( const class ITargetPlatformSettings TargetPlatformSettings,
const class ITargetPlatformControls TargetPlatformControls,
int32 OutSizeX,
int32 OutSizeY,
int32 OutSizeZ 
) const

◆ GetBuiltTextureSize() [3/4]

void UTexture::GetBuiltTextureSize ( const ITargetPlatform TargetPlatform,
int32 OutSizeX,
int32 OutSizeY 
) const
inline

◆ GetBuiltTextureSize() [4/4]

void UTexture::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

◆ GetCachedLODBias()

int32 UTexture::GetCachedLODBias ( ) const
inlineoverridevirtual

Returns the combined LOD bias based on texture LOD group and LOD bias. Function name is legacy and incorrect, it is no longer cached

Returns
LOD bias

Reimplemented from UStreamableRenderAsset.

◆ GetCookedPlatformData()

virtual TMap< FString, FTexturePlatformData * > * UTexture::GetCookedPlatformData ( )
inlinevirtual

◆ GetExternalTextureGuid()

virtual FGuid UTexture::GetExternalTextureGuid ( ) const
inlinevirtual

Access the GUID which defines this texture's resources externally through FExternalTextureRegistry

Reimplemented in UARTexture, UAREnvironmentCaptureProbeTexture, UMediaTexture, and UWebBrowserTexture.

◆ GetGammaSpace()

EGammaSpace UTexture::GetGammaSpace ( ) const
inline

◆ GetLastRenderTimeForStreaming()

float UTexture::GetLastRenderTimeForStreaming ( ) const
finaloverridevirtual

Get the per-asset last render time. FLT_MAX means never use UnknownRefHeuristic and the asset will only keep non-streamable LODs when there is no instance/reference in the scene

Reimplemented from UStreamableRenderAsset.

◆ GetLightingGuid()

const FGuid & UTexture::GetLightingGuid ( ) const
inline

Returns a unique identifier for this texture. Used by the lighting build and texture streamer.

◆ GetLODGroupForStreaming()

virtual int32 UTexture::GetLODGroupForStreaming ( ) const
inlinefinaloverridevirtual

Get an integer representation of the LOD group

Reimplemented from UStreamableRenderAsset.

◆ GetMaximumDimensionOfNonVT()

int32 UTexture::GetMaximumDimensionOfNonVT ( )
static

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

◆ GetMipGenSettingsFromString()

TextureMipGenSettings UTexture::GetMipGenSettingsFromString ( const TCHAR InStr,
bool  bTextureGroup 
)
static

◆ GetMipGenSettingsString()

const TCHAR * UTexture::GetMipGenSettingsString ( TextureMipGenSettings  InEnum)
static

◆ GetMipIoFilenameHash()

FIoFilenameHash UTexture::GetMipIoFilenameHash ( const int32  MipIndex) const
finaloverridevirtual

Reimplemented from UStreamableRenderAsset.

◆ GetPixelFormatEnum()

UEnum * UTexture::GetPixelFormatEnum ( )
static

Retrieves the pixel format enum for enum <-> string conversions.

◆ GetRenderAssetType()

virtual EStreamableRenderAssetType UTexture::GetRenderAssetType ( ) const
inlinefinaloverridevirtual

Reimplemented from UStreamableRenderAsset.

◆ GetResource() [1/2]

FTextureResource * UTexture::GetResource ( )

Get the texture's resource, can be NULL

◆ GetResource() [2/2]

const FTextureResource * UTexture::GetResource ( ) const

Get the const texture's resource, can be NULL

◆ GetResourcePostInitState()

FStreamableRenderResourceState UTexture::GetResourcePostInitState ( const FTexturePlatformData PlatformData,
bool  bAllowStreaming,
int32  MinRequestMipCount = 0,
int32  MaxMipCount = 0,
bool  bSkipCanBeLoaded = false 
) const
protected

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

Parameters
PlatformData- the asset platform data.
bAllowStreaming- where streaming is allowed, might still be disabled based on asset settings.
MaxMipCount- optional limitation on the max mip count.
Returns
The state to be passed to FStreamableTextureResource.

◆ GetRunningPlatformData()

virtual FTexturePlatformData ** UTexture::GetRunningPlatformData ( )
inlinevirtual

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

Reimplemented in UTexture2D, UTexture2DArray, UTextureCube, UTextureCubeArray, and UVolumeTexture.

◆ GetStaticMinTextureResidentMipCount()

static int32 UTexture::GetStaticMinTextureResidentMipCount ( )
inlinestatic

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

◆ GetTextureAddressX()

virtual TextureAddress UTexture::GetTextureAddressX ( ) const
inlinevirtual

Reimplemented in UTexture2D, UTexture2DArray, and UVolumeTexture.

◆ GetTextureAddressY()

virtual TextureAddress UTexture::GetTextureAddressY ( ) const
inlinevirtual

Reimplemented in UTexture2D, UTexture2DArray, and UVolumeTexture.

◆ GetTextureAddressZ()

virtual TextureAddress UTexture::GetTextureAddressZ ( ) const
inlinevirtual

Reimplemented in UTexture2DArray, and UVolumeTexture.

◆ GetTextureGroupString()

const TCHAR * UTexture::GetTextureGroupString ( TextureGroup  InGroup)
static

◆ GetTextureStreamingMethod()

ETextureStreamingMethod UTexture::GetTextureStreamingMethod ( ) const

Returns the type of streaming the texture is currently using on the current platform. (None/Streamed/Virtual)

◆ GetVirtualTextureBuildSettings()

void UTexture::GetVirtualTextureBuildSettings ( struct FVirtualTextureBuildSettings OutSettings) const
virtual

Returns the virtual texture build settings.

Reimplemented in UMaterialCacheVirtualTexture.

◆ HasHDRSource()

bool UTexture::HasHDRSource ( int32  LayerIndex = 0) const
inline

Checks whether this texture has a high dynamic range (HDR) source.

Returns
true if the texture has an HDR source, false otherwise.

◆ HasPendingLODTransition()

bool UTexture::HasPendingLODTransition ( ) const
finaloverridevirtual

Reimplemented from UStreamableRenderAsset.

◆ HasPendingRenderResourceInitialization()

bool UTexture::HasPendingRenderResourceInitialization ( ) const
finaloverridevirtual

Reimplemented from UStreamableRenderAsset.

◆ ImportCustomProperties()

void UTexture::ImportCustomProperties ( const TCHAR SourceText,
FFeedbackContext Warn 
)
overridevirtual

Exports the property values for the specified object as text to the output device. Required for Copy&Paste Override this if you need custom support for copy/paste.

Parameters
SourceTextThe input data (zero terminated), will never be null
WarnFor error reporting, will never be null
See also
ExportCustomProperties()

Reimplemented from UObject.

◆ InvalidateLastRenderTimeForStreaming()

void UTexture::InvalidateLastRenderTimeForStreaming ( )
finaloverridevirtual

Invalidates per-asset last render time. Mainly used to opt in UnknownRefHeuristic during LOD index calculation. See FStreamingRenderAsset::bUseUnknownRefHeuristic

Reimplemented from UStreamableRenderAsset.

◆ IsCookPlatformTilingDisabled() [1/2]

bool UTexture::IsCookPlatformTilingDisabled ( const ITargetPlatform TargetPlatform) const

Legacy function to support the old API, will call IsCookPlatformTilingDisabled with ITargetPlatformSettings

◆ IsCookPlatformTilingDisabled() [2/2]

bool UTexture::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

Parameters
TargetPlatformSettingsThe platform for which the texture is being cooked and texture group info will be extracted from. If null, this info will be extracted from UDeviceProfileManager::Get().GetActiveProfile(), possibly at runtime
Returns
true if platform tiling during cook is disabled for this texture

◆ IsCurrentlyVirtualTextured()

virtual bool UTexture::IsCurrentlyVirtualTextured ( ) const
inlinevirtual

Returns if the texture is actually being rendered using virtual texturing right now. Unlike the 'VirtualTextureStreaming' property which reflects the user's desired state this reflects the actual current state on the renderer depending on the platform, VT data being built, project settings, ....

Reimplemented in UTexture2D, and UMaterialCacheVirtualTexture.

◆ IsNormalMap()

bool UTexture::IsNormalMap ( ) const
inline
Returns
true if the compression type is a normal map compression type

◆ IsPossibleToStream()

bool UTexture::IsPossibleToStream ( ) const

Do the Texture properties make it a possible candidate for streaming. Can be called by editor or runtime. If true, does not mean it will actually be streamed, but if false will definitely not be streamed.

◆ IsPostLoadThreadSafe()

bool UTexture::IsPostLoadThreadSafe ( ) const
overridevirtual

Called during async load to determine if PostLoad can be called on the loading thread.

Returns
true if this object's PostLoad is thread safe

Reimplemented from UObject.

Reimplemented in UMediaTexture.

◆ IsReadyForFinishDestroy()

bool UTexture::IsReadyForFinishDestroy ( )
overridevirtual

Called to check if the object is ready for FinishDestroy. This is called after BeginDestroy to check the completion of the potentially asynchronous object cleanup.

Returns
True if the object's asynchronous cleanup has completed and it is ready for FinishDestroy to be called.

Reimplemented from UStreamableRenderAsset.

◆ IsUncompressed()

bool UTexture::IsUncompressed ( ) const
inline
Returns
true if the texture has an uncompressed texture setting

◆ IsVirtualTexturingEnabled()

bool UTexture::IsVirtualTexturingEnabled ( const ITargetPlatformSettings TargetPlatform = nullptr)
static

Check the Project settings to see if VT is enabled. Optionally also checks the TargetPlatform.

◆ PostCDOContruct()

void UTexture::PostCDOContruct ( )
overridevirtual

Called after the C++ constructor has run on the Class Default Object (CDO) for a class. This is an obscure routine used to deal with the recursion in the construction of the default materials

Reimplemented from UObject.

◆ PostEditImport()

void UTexture::PostEditImport ( )
overridevirtual

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

Reimplemented from UObject.

◆ PostInitProperties()

void UTexture::PostInitProperties ( )
overridevirtual

Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

Reimplemented from UObject.

Reimplemented in UMediaTexture.

◆ PostLoad()

void UTexture::PostLoad ( )
overridevirtual

Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

Reimplemented from UObject.

Reimplemented in UTexture2D, UTexture2DArray, UTextureCube, UTextureCubeArray, UVolumeTexture, and UMediaTexture.

◆ PreSave()

void UTexture::PreSave ( FObjectPreSaveContext  SaveContext)
overridevirtual

Presave function. Gets called once before an object gets serialized for saving. This function is necessary for save time computation as Serialize gets called three times per object from within SavePackage.

Warning
: Objects created from within PreSave will NOT have PreSave called on them!!!

Reimplemented from UObject.

Reimplemented in UTexture2D.

◆ ReleaseResource()

void UTexture::ReleaseResource ( )

Resets the resource for the texture.

◆ RemoveUserDataOfClass()

void UTexture::RemoveUserDataOfClass ( TSubclassOf< UAssetUserData InUserDataClass)
overridevirtual

Reimplemented from IInterface_AssetUserData.

◆ Serialize()

void UTexture::Serialize ( FArchive Ar)
overridevirtual

Handles reading, writing, and reference collecting using FArchive. This implementation handles all FProperty serialization, but can be overridden for native variables.

Legacy serialization.

Reimplemented from UObject.

Reimplemented in UTexture2D, UTexture2DArray, UTextureCube, UTextureCubeArray, and UVolumeTexture.

◆ SerializeCookedPlatformData()

void UTexture::SerializeCookedPlatformData ( class FArchive Ar,
const bool  bSerializeMipData = true 
)

Serializes cooked platform data.

◆ SetDeterministicLightingGuid()

void UTexture::SetDeterministicLightingGuid ( )

Generates a deterministic GUID for the texture based on the full name of the object. Used to ensure that assets created during cook can be deterministic

◆ SetLightingGuid() [1/2]

void UTexture::SetLightingGuid ( )
inline

Assigns a new GUID to a texture. This will be called whenever a texture is created or changes. In game, the GUIDs are only used by the texture streamer to link build data to actual textures, that means new textures don't actually need GUIDs (see FStreamingTextureLevelContext)

◆ SetLightingGuid() [2/2]

void UTexture::SetLightingGuid ( const FGuid Guid)
inline

◆ SetMinTextureResidentMipCount()

void UTexture::SetMinTextureResidentMipCount ( int32  InMinTextureResidentMipCount)
static

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

◆ SetResource()

PRAGMA_ENABLE_DEPRECATION_WARNINGS void UTexture::SetResource ( FTextureResource Resource)

Set texture's resource, can be NULL

◆ ShouldMipLevelsBeForcedResident()

bool UTexture::ShouldMipLevelsBeForcedResident ( ) const
finaloverridevirtual

Returns whether miplevels should be forced resident.

Returns
true if either transient or serialized override requests miplevels to be resident, false otherwise

Reimplemented from UStreamableRenderAsset.

◆ UpdateCachedLODBias()

void UTexture::UpdateCachedLODBias ( )
inline

Cache the combined LOD bias based on texture LOD group and LOD bias.

◆ UpdateResource()

virtual void UTexture::UpdateResource ( )
inlinevirtual

Creates a new resource for the texture, and updates any cached references to the resource. If you are deriving this function you should update your class to derive UpdateResourceWithParams as this function is intended to be a convenience function to access the None version of UpdateResourceWithParams and only retains virtual to avoid breaking existing code.

Reimplemented in UCanvasRenderTarget2D, and UMediaTexture.

◆ UpdateResourceWithParams()

void UTexture::UpdateResourceWithParams ( EUpdateResourceFlags  InFlags)
virtual

Creates a new resource for the texture, and updates any cached references to the resource. It is always best practice to call BlockOnAnyAsyncBuild() before assuming the resource is ready if you need it immediately, even if you use the Synchronous flag to ensure the texture compiler has finished with it.

Reimplemented in UCanvasRenderTarget2D, UTexture2D, UTexture2DArray, UTextureCube, UTextureCubeArray, UVolumeTexture, and UMaterialCacheVirtualTexture.

Member Data Documentation

◆ AssetUserData

TArray<TObjectPtr<UAssetUserData> > UTexture::AssetUserData
protected

Array of user data stored with the asset

◆ Availability

ETextureAvailability UTexture::Availability

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. For CPU availability, the texture will still upload a tiny black texture as a placeholder. Only applies to 2d textures.

◆ bNoTiling

uint8 UTexture::bNoTiling

If true, the RHI texture will be created using TexCreate_NoTiling

◆ bNotOfflineProcessed

uint8 UTexture::bNotOfflineProcessed

If true, the RHI texture will be created without TexCreate_OfflineProcessed. This controls what format the data will be uploaded to RHI. Offline processed textures may have platform specific tiling applied, and/or have their mip tails pre-combined into a single mip's data. If NotOffline, then it will expect data to be uploaded in standard per-mip layouts.

◆ bOodlePreserveExtremes

bool UTexture::bOodlePreserveExtremes = false

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.

◆ bUseVirtualTextureStreamingPriority

uint32 UTexture::bUseVirtualTextureStreamingPriority

Override the virtual texture streaming priority set on this texture by the texture LOD group.

◆ CompressionSettings

TEnumAsByte<enum TextureCompressionSettings> UTexture::CompressionSettings

Compression settings to use when building the texture.

◆ CompressionYCoCg

uint8 UTexture::CompressionYCoCg

If true the texture stores YCoCg. Blue channel will be filled with a precision scale during compression.

◆ CookPlatformTilingSettings

TEnumAsByte<enum TextureCookPlatformTilingSettings> UTexture::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.

◆ CreateResource

virtual class FTextureResource* UTexture::CreateResource() PURE_VIRTUAL(UTexture

Implemented by subclasses to create a new resource for the texture.

◆ Downscale

FPerPlatformFloat UTexture::Downscale

Downscale source texture, applied only to 2d textures without mips < 1.0 - use scale value from texture group 1.0 - do not scale texture

‍1.0 - scale texure

◆ DownscaleOptions

ETextureDownscaleOptions UTexture::DownscaleOptions

Texture downscaling options

◆ Filter

TEnumAsByte<enum TextureFilter> UTexture::Filter

The texture filtering mode to use when sampling this texture.

◆ GetMaterialType

virtual EMaterialValueType UTexture::GetMaterialType() const PURE_VIRTUAL(UTexture
Returns
The material value type of this texture.

◆ GetSurfaceArraySize

virtual uint32 UTexture::GetSurfaceArraySize() const PURE_VIRTUAL(UTexture
Returns
the array size of the surface represented by the texture.

◆ GetSurfaceDepth

virtual float UTexture::GetSurfaceDepth() const PURE_VIRTUAL(UTexture
Returns
the depth of the surface represented by the texture.

◆ GetSurfaceHeight

virtual float UTexture::GetSurfaceHeight() const PURE_VIRTUAL(UTexture
Returns
the height of the surface represented by the texture.

◆ GetSurfaceWidth

virtual float UTexture::GetSurfaceWidth() const PURE_VIRTUAL(UTexture
Returns
the width of the surface represented by the texture.

◆ GetTextureClass

virtual ETextureClass UTexture::GetTextureClass() const PURE_VIRTUAL(UTexture

Get Texture Class

◆ GMinTextureResidentMipCount

int32 UTexture::GMinTextureResidentMipCount = NUM_INLINE_DERIVED_MIPS
staticprotected

The minimum number of mips that must be resident in memory (cannot be streamed).

◆ LevelIndex

int32 UTexture::LevelIndex = INDEX_NONE

◆ LODBias

int32 UTexture::LODBias

A bias to the index of the top mip level to use. That is, number of mip levels to drop when cooking.

◆ LODGroup

TEnumAsByte<enum TextureGroup> UTexture::LODGroup

Texture group this texture belongs to

◆ MipLoadOptions

ETextureMipLoadOptions UTexture::MipLoadOptions

The texture mip load options.

◆ PreSaveEvent

UTexture::FOnTextureSaved UTexture::PreSaveEvent
static

triggered before a texture is being saved

◆ ReleaseFence

FRenderCommandFence UTexture::ReleaseFence

Release fence to know when resources have been freed on the rendering thread.

◆ SRGB

uint8 UTexture::SRGB

Whether Texture and its source are in SRGB Gamma color space. Can only be used with 8-bit and compressed formats. This should be unchecked if using alpha channels individually as masks.

◆ TextureReference

FTextureReference& UTexture::TextureReference

Stable RHI texture reference that refers to the current RHI texture. Note this is manually refcounted!

◆ VirtualTexturePrefetchMips

uint8 UTexture::VirtualTexturePrefetchMips = 0

The number of mips that a virtual texture can stream using the traditional CPU texture streaming system. In most cases this should be 0 because the virtual texture GPU feedback is sufficient and will minimize memory usage. But CPU prefetching can be used in some cases to avoid late appearance of mips.

◆ VirtualTextureStreaming

uint8 UTexture::VirtualTextureStreaming

Is this texture streamed in using VT

◆ VirtualTextureStreamingPriority

EVTProducerPriority UTexture::VirtualTextureStreamingPriority

Priority to use when using virtual texture streaming for this texture.


The documentation for this class was generated from the following files: