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

#include <Texture2D.h>

+ Inheritance diagram for UTexture2D:

Public Member Functions

FIntPoint GetImportedSize () const
 
ENGINE_API void SetPlatformData (FTexturePlatformData *PlatformData)
 
ENGINE_API FTexturePlatformDataGetPlatformData ()
 
ENGINE_API const FTexturePlatformDataGetPlatformData () const
 
UTextureAllMipDataProviderFactoryGetAllMipProvider () const
 
virtual void Serialize (FArchive &Ar) override
 
virtual void BeginDestroy () override
 
virtual bool IsReadyForAsyncPostLoad () const override
 
virtual void PostLoad () override
 
virtual void PreSave (FObjectPreSaveContext ObjectSaveContext) override
 
virtual void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const override
 
virtual void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const override
 
virtual FString GetDesc () override
 
virtual ETextureClass GetTextureClass () const override
 
virtual float GetSurfaceWidth () const override
 
virtual float GetSurfaceHeight () const override
 
virtual float GetSurfaceDepth () const override
 
virtual uint32 GetSurfaceArraySize () const override
 
virtual TextureAddress GetTextureAddressX () const override
 
virtual TextureAddress GetTextureAddressY () const override
 
virtual FTextureResourceCreateResource () override
 
virtual EMaterialValueType GetMaterialType () const override
 
virtual void UpdateResourceWithParams (EUpdateResourceFlags InFlags) override
 
virtual float GetAverageBrightness (bool bIgnoreTrueBlack, bool bUseGrayscale) override
 
virtual FTexturePlatformData ** GetRunningPlatformData () final override
 
virtual int32 CalcCumulativeLODSize (int32 NumLODs) const final override
 
ENGINE_API int32 GetNumResidentMips () const
 
virtual ENGINE_API bool StreamOut (int32 NewMipCount) final override
 
virtual ENGINE_API bool StreamIn (int32 NewMipCount, bool bHighPrio) final override
 
ENGINE_API int32 GetSizeX () const
 
ENGINE_API int32 GetSizeY () const
 
ENGINE_API int32 GetNumMips () const
 
ENGINE_API EPixelFormat GetPixelFormat (uint32 LayerIndex=0u) const
 
ENGINE_API int32 GetMipTailBaseIndex () const
 
ENGINE_API const TIndirectArray< FTexture2DMipMap > & GetPlatformMips () const
 
ENGINE_API int32 GetExtData () const
 
ENGINE_API int32 GetNumMipsAllowed (bool bIgnoreMinResidency) const
 
int32 GetMinTextureResidentMipCount () const
 
ENGINE_API void GetMipData (int32 FirstMipToLoad, void **OutMipData)
 
virtual bool GetInitialMipData (int32 InFirstMipToLoad, TArrayView< void * > OutMipData, TArrayView< int64 > OutMipSize)
 
int32 CalcTextureMemorySize (int32 MipCount) const
 
virtual uint32 CalcTextureMemorySizeEnum (ETextureMipCount Enum) const override
 
ENGINE_API bool GetSourceArtCRC (uint32 &OutSourceCRC)
 
ENGINE_API bool HasSameSourceArt (UTexture2D *InTexture)
 
ENGINE_API bool HasAlphaChannel () const
 
virtual void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize) override
 
bool GetResourceMemSettings (int32 FirstMipIdx, int32 &OutSizeX, int32 &OutSizeY, int32 &OutNumMips, uint32 &OutTexCreateFlags)
 
ENGINE_API void UpdateTextureRegions (int32 MipIndex, uint32 NumRegions, const FUpdateTextureRegion2D *Regions, uint32 SrcPitch, uint32 SrcBpp, uint8 *SrcData, TFunction< void(uint8 *SrcData, const FUpdateTextureRegion2D *Regions)> DataCleanupFunc=[](uint8 *, const FUpdateTextureRegion2D *){})
 
ENGINE_API FSharedImageConstRef GetCPUCopy () const
 
FSharedImageConstRefBlueprint Blueprint_GetCPUCopy () const
 
int32 Blueprint_GetSizeX () const
 
int32 Blueprint_GetSizeY () const
 
virtual void RefreshSamplerStates ()
 
virtual bool IsCurrentlyVirtualTextured () const override
 
virtual bool IsVirtualTexturedWithContinuousUpdate () const
 
virtual bool IsVirtualTexturedWithSinglePhysicalSpace () const
 
virtual bool IsVirtualTexturedWithSinglePhysicalPool () const
 
- Public Member Functions inherited from UTexture
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 ()
 
void UpdateCachedLODBias ()
 
int32 GetCachedLODBias () const override
 
ENGINE_API int32 CalculateLODBias (bool bWithCinematicMipBias) const
 
ENGINE_API ETextureStreamingMethod GetTextureStreamingMethod () const
 
virtual ENGINE_API void GetVirtualTextureBuildSettings (struct FVirtualTextureBuildSettings &OutSettings) const
 
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 GetTextureAddressZ () const
 
virtual FGuid GetExternalTextureGuid () const
 
virtual ENGINE_API void PostInitProperties () 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
 
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
 
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 ()
 
ENGINE_API void CancelPendingStreamingRequest ()
 
ENGINE_API bool HasPendingInitOrStreaming (bool bWaitForLODTransition=false) const
 
bool IsPendingStreamingRequestLocked () const
 
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 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)
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) 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 float GetGlobalMipMapLODBias ()
 
static ENGINE_API class UTexture2DCreateTransient (int32 InSizeX, int32 InSizeY, EPixelFormat InFormat=PF_B8G8R8A8, const FName InName=NAME_None, TConstArrayView64< uint8 > InImageData=TConstArrayView64< uint8 >())
 
static ENGINE_API class UTexture2DCreateTransientFromImage (const FImage *InImage, const FName InName=NAME_None)
 
- Static Public Member Functions inherited from UTexture
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 FirstResourceMemMip
 
TEnumAsByte< enum TextureAddressAddressX
 
TEnumAsByte< enum TextureAddressAddressY
 
FTexture2DResourceMemResourceMem
 
- Public Attributes inherited from UTexture
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
 

Friends

class FTexture2DUpdate
 
struct FRenderAssetStreamingManager
 
struct FStreamingRenderAsset
 

Additional Inherited Members

- Public Types inherited from UTexture
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
 
- Static Public Attributes inherited from UTexture
static ENGINE_API FOnTextureSaved PreSaveEvent
 
- Protected Member Functions inherited from UTexture
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 inherited from UTexture
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 inherited from UTexture
static ENGINE_API int32 GMinTextureResidentMipCount = NUM_INLINE_DERIVED_MIPS
 

Member Function Documentation

◆ BeginDestroy()

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

◆ Blueprint_GetCPUCopy()

FSharedImageConstRefBlueprint UTexture2D::Blueprint_GetCPUCopy ( ) const

◆ Blueprint_GetSizeX()

int32 UTexture2D::Blueprint_GetSizeX ( ) const

Gets the X size of the texture, in pixels

◆ Blueprint_GetSizeY()

int32 UTexture2D::Blueprint_GetSizeY ( ) const

Gets the Y size of the texture, in pixels

◆ CalcCumulativeLODSize()

virtual int32 UTexture2D::CalcCumulativeLODSize ( int32  NumLODs) const
inlinefinaloverridevirtual

Reimplemented from UStreamableRenderAsset.

◆ CalcTextureMemorySize()

int32 UTexture2D::CalcTextureMemorySize ( int32  MipCount) const

Calculates the size of this texture in bytes if it had MipCount miplevels streamed in.

Parameters
MipCountNumber of mips to calculate size for, counting from the smallest 1x1 mip-level and up.
Returns
Size of MipCount mips in bytes

◆ CalcTextureMemorySizeEnum()

uint32 UTexture2D::CalcTextureMemorySizeEnum ( ETextureMipCount  Enum) const
overridevirtual

Calculates the size of this texture if it had MipCount miplevels streamed in.

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

Reimplemented from UTexture.

◆ CreateResource()

FTextureResource * UTexture2D::CreateResource ( )
overridevirtual

◆ CreateTransient()

UTexture2D * UTexture2D::CreateTransient ( int32  InSizeX,
int32  InSizeY,
EPixelFormat  InFormat = PF_B8G8R8A8,
const FName  InName = NAME_None,
TConstArrayView64< uint8 InImageData = TConstArrayView64<uint8>() 
)
static

creates and initializes a new Texture2D with the requested settings. The texture will have 1 mip level of the given size, optionally filled with the provided data.

◆ CreateTransientFromImage()

UTexture2D * UTexture2D::CreateTransientFromImage ( const FImage InImage,
const FName  InName = NAME_None 
)
static

creates a new texture2d from the first slice of the given image. If the image format isn't supported a texture isn't created.

◆ GetAllMipProvider()

UTextureAllMipDataProviderFactory * UTexture2D::GetAllMipProvider ( ) const
inline

◆ GetAssetRegistryTags() [1/2]

void UTexture2D::GetAssetRegistryTags ( FAssetRegistryTagsContext  Context) const
overridevirtual

Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

Parameters
OutTagsA list of key-value pairs associated with this object and their types

Reimplemented from UObject.

◆ GetAssetRegistryTags() [2/2]

void UTexture2D::GetAssetRegistryTags ( TArray< FAssetRegistryTag > &  OutTags) const
overridevirtual

Reimplemented from UObject.

◆ GetAverageBrightness()

float UTexture2D::GetAverageBrightness ( bool  bIgnoreTrueBlack,
bool  bUseGrayscale 
)
overridevirtual

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 from UTexture.

◆ GetCPUCopy()

FSharedImageConstRef UTexture2D::GetCPUCopy ( ) const

If the texture has a cpu accessible copy, this returns that copy. It will wait for encoding in the editor, but otherwise may return an invalid reference if the texture is not ready or doesn't have a cpu copy.

◆ GetDesc()

FString UTexture2D::GetDesc ( void  )
overridevirtual

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

Reimplemented from UObject.

◆ GetExtData()

int32 UTexture2D::GetExtData ( ) const

◆ GetGlobalMipMapLODBias()

float UTexture2D::GetGlobalMipMapLODBias ( )
static

Returns the global mip map bias applied as an offset for 2d textures.

◆ GetImportedSize()

FIntPoint UTexture2D::GetImportedSize ( ) const
inline

Retrieves the size of the source image from which the texture was created.

◆ GetInitialMipData()

bool UTexture2D::GetInitialMipData ( int32  InFirstMipToLoad,
TArrayView< void * >  OutMipData,
TArrayView< int64 OutMipSize 
)
virtual

Retrieve initial texel data for mips, starting from FirstMipToLoad, up to the last mip in the texture. This function will only return mips that are currently loaded, or available via derived data. THIS FUNCTION WILL FAIL if you include in the requested range a streaming mip that is NOT currently loaded. Also note that ALL mip bulk data buffers are discarded (either returned or freed). So... in short, this function should only ever be called once.

Parameters
FirstMipToLoad- The first mip index to load.
OutMipData- A pre-allocated array of pointers, that correspond to [FirstMipToLoad, .... LastMip] Upon successful return, each of those pointers will point to allocated memory containing the corresponding mip's data. Caller takes responsibility to free that memory.
OutMipSize- A pre-allocated array of int64, that should be the same size as OutMipData (or zero size if caller does not require the sizes to be returned) Upon successful return, each element contains the size of the corresponding mip's data buffer.
Returns
true if the requested mip data has been successfully returned.

◆ GetMaterialType()

EMaterialValueType UTexture2D::GetMaterialType ( ) const
overridevirtual

◆ GetMinTextureResidentMipCount()

int32 UTexture2D::GetMinTextureResidentMipCount ( ) const
inline

Returns the minimum number of mips that must be resident in memory (cannot be streamed). This does not correctly account for NonStreaming mips and other constraints. This function is not correct and should not be used.

◆ GetMipData()

void UTexture2D::GetMipData ( int32  FirstMipToLoad,
void **  OutMipData 
)

Get the PlatformData mip data starting with the specified mip index.

Parameters
FirstMipToLoad- The first mip index to cache.
OutMipData- Must point to an array of pointers with at least Mips.Num() - FirstMipToLoad + 1 entries. Upon return those pointers will contain mip data.

prefer TryLoadMipsWithSizes

todo: deprecate this API when possible this API is also duplicated in Texture2DArray and TextureCube unify and fix them all also don't use "GetMipData" as that is the name used for TextureSource

◆ GetMipTailBaseIndex()

int32 UTexture2D::GetMipTailBaseIndex ( ) const

◆ GetNumMips()

int32 UTexture2D::GetNumMips ( ) const

◆ GetNumMipsAllowed()

int32 UTexture2D::GetNumMipsAllowed ( bool  bIgnoreMinResidency) const

Calculates the maximum number of mips that will be in this texture after cooking (eg. after the "drop mip" lod bias is applied). This function is not correct and should not be used.

The cinematic mips will be considered as loadable, streaming enabled or not. Note that in the cooking process, mips smaller than the min residency count can be stripped out by the cooker.

Parameters
bIgnoreMinResidency- Whether to ignore min residency limitations.
Returns
The maximum allowed number mips for this texture.

◆ GetNumResidentMips()

int32 UTexture2D::GetNumResidentMips ( ) const

◆ GetPixelFormat()

EPixelFormat UTexture2D::GetPixelFormat ( uint32  LayerIndex = 0u) const

◆ GetPlatformData() [1/2]

FTexturePlatformData * UTexture2D::GetPlatformData ( )

Get the derived data for this texture on this platform.

◆ GetPlatformData() [2/2]

const FTexturePlatformData * UTexture2D::GetPlatformData ( ) const

Get the const derived data for this texture on this platform.

◆ GetPlatformMips()

const TIndirectArray< FTexture2DMipMap > & UTexture2D::GetPlatformMips ( ) const

◆ GetResourceMemSettings()

bool UTexture2D::GetResourceMemSettings ( int32  FirstMipIdx,
int32 OutSizeX,
int32 OutSizeY,
int32 OutNumMips,
uint32 OutTexCreateFlags 
)

Calculates and returns the corresponding ResourceMem parameters for this texture.

Parameters
FirstMipIdxIndex of the largest mip-level stored within a seekfree (level) package
OutSizeX[out] Width of the stored largest mip-level
OutSizeY[out] Height of the stored largest mip-level
OutNumMips[out] Number of stored mips
OutTexCreateFlags[out] ETextureCreateFlags bit flags
Returns
true if the texture should use a ResourceMem. If false, none of the out parameters will be filled in.

◆ GetResourceSizeEx()

void UTexture2D::GetResourceSizeEx ( FResourceSizeEx CumulativeResourceSize)
overridevirtual

Returns the size of the object/ resource for display to artists/ LDs in the Editor.

Returns
size of resource as to be displayed to artists/ LDs in the Editor.

Reimplemented from UObject.

◆ GetRunningPlatformData()

FTexturePlatformData ** UTexture2D::GetRunningPlatformData ( )
finaloverridevirtual

Get the optimal placeholder to use during texture compilation

Reimplemented from UTexture.

◆ GetSizeX()

int32 UTexture2D::GetSizeX ( ) const

Trivial accessors.

◆ GetSizeY()

int32 UTexture2D::GetSizeY ( ) const

◆ GetSourceArtCRC()

bool UTexture2D::GetSourceArtCRC ( uint32 OutSourceCRC)

Get the CRC of the source art pixels.

Parameters
[out]OutSourceCRCThe CRC value of the source art pixels.
Returns
bool true if successful, false if failed (or no source art)

◆ GetSurfaceArraySize()

virtual uint32 UTexture2D::GetSurfaceArraySize ( ) const
inlineoverridevirtual

◆ GetSurfaceDepth()

virtual float UTexture2D::GetSurfaceDepth ( ) const
inlineoverridevirtual

◆ GetSurfaceHeight()

virtual float UTexture2D::GetSurfaceHeight ( ) const
inlineoverridevirtual

◆ GetSurfaceWidth()

virtual float UTexture2D::GetSurfaceWidth ( ) const
inlineoverridevirtual

◆ GetTextureAddressX()

virtual TextureAddress UTexture2D::GetTextureAddressX ( ) const
inlineoverridevirtual

Reimplemented from UTexture.

◆ GetTextureAddressY()

virtual TextureAddress UTexture2D::GetTextureAddressY ( ) const
inlineoverridevirtual

Reimplemented from UTexture.

◆ GetTextureClass()

virtual ETextureClass UTexture2D::GetTextureClass ( ) const
inlineoverridevirtual

◆ HasAlphaChannel()

bool UTexture2D::HasAlphaChannel ( ) const

Returns true if the runtime texture has an alpha channel that is not completely white.

◆ HasSameSourceArt()

bool UTexture2D::HasSameSourceArt ( UTexture2D InTexture)

See if the source art of the two textures matches...

Parameters
InTextureThe texture to compare it to
Returns
bool true if they matche, false if not

◆ IsCurrentlyVirtualTextured()

bool UTexture2D::IsCurrentlyVirtualTextured ( ) const
overridevirtual

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 from UTexture.

◆ IsReadyForAsyncPostLoad()

bool UTexture2D::IsReadyForAsyncPostLoad ( ) const
overridevirtual

Called before calling PostLoad() in FAsyncPackage::PostLoadObjects(). This is the safeguard to prevent PostLoad() from stalling the main thread.

Reimplemented from UObject.

◆ IsVirtualTexturedWithContinuousUpdate()

virtual bool UTexture2D::IsVirtualTexturedWithContinuousUpdate ( ) const
inlinevirtual

Returns true if this virtual texture requests round-robin updates of the virtual texture pages.

◆ IsVirtualTexturedWithSinglePhysicalPool()

virtual bool UTexture2D::IsVirtualTexturedWithSinglePhysicalPool ( ) const
inlinevirtual

Returns true if this virtual texture requires that it's physical pool is never split by the r.VT.PageTableSupportType=2 setting. This is necessary if the texture is part of a system that assumes that all textures in the system are in the same physical pool. Note that textures with this setting will necessarily be put in different physical spaces to those without the setting.

◆ IsVirtualTexturedWithSinglePhysicalSpace()

virtual bool UTexture2D::IsVirtualTexturedWithSinglePhysicalSpace ( ) const
inlinevirtual

Returns true if this virtual texture uses a single physical space all of its texture layers. This can reduce page table overhead but potentially increase the number of physical pools allocated.

◆ PostLoad()

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

◆ PreSave()

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

◆ RefreshSamplerStates()

void UTexture2D::RefreshSamplerStates ( )
virtual

Update the offset for mip map lod bias. This is added to any existing mip bias values.

◆ Serialize()

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

◆ SetPlatformData()

void UTexture2D::SetPlatformData ( FTexturePlatformData PlatformData)

Set the derived data for this texture on this platform.

◆ StreamIn()

bool UTexture2D::StreamIn ( int32  NewMipCount,
bool  bHighPrio 
)
finaloverridevirtual

Loads mips from disk to memory. Only usable if the asset is streamable.

Parameters
NewMipCount- The desired mip count after the mips are loaded.
bHighPrio- true if the load request is of high priority and must be issued before other asset requests.
Returns
Whether any mips were resquested to be loaded.

Reimplemented from UStreamableRenderAsset.

◆ StreamOut()

bool UTexture2D::StreamOut ( int32  NewMipCount)
finaloverridevirtual

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

Parameters
NewMipCount- The desired mip count after the mips are unloaded.
Returns
Whether any mips were requested to be unloaded.

Reimplemented from UStreamableRenderAsset.

◆ UpdateResourceWithParams()

void UTexture2D::UpdateResourceWithParams ( EUpdateResourceFlags  InFlags)
overridevirtual

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 from UTexture.

◆ UpdateTextureRegions()

void UTexture2D::UpdateTextureRegions ( int32  MipIndex,
uint32  NumRegions,
const FUpdateTextureRegion2D Regions,
uint32  SrcPitch,
uint32  SrcBpp,
uint8 SrcData,
TFunction< void(uint8 *SrcData, const FUpdateTextureRegion2D *Regions)>  DataCleanupFunc = [](uint8*, const FUpdateTextureRegion2D*){} 
)

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

Parameters
MipIndex- the mip number to update
NumRegions- number of regions to update
Regions- regions to update
SrcPitch- the pitch of the source data in bytes
SrcBpp- the size one pixel data in bytes
SrcData- the source data
DataCleanupFunc- a function that will be called to clean up the SrcData and Regions after the update.

Friends And Related Symbol Documentation

◆ FRenderAssetStreamingManager

◆ FStreamingRenderAsset

◆ FTexture2DUpdate

friend class FTexture2DUpdate
friend

Helper to manage the current pending update following a call to StreamIn() or StreamOut().

Member Data Documentation

◆ AddressX

TEnumAsByte<enum TextureAddress> UTexture2D::AddressX

The addressing mode to use for the X axis.

◆ AddressY

TEnumAsByte<enum TextureAddress> UTexture2D::AddressY

The addressing mode to use for the Y axis.

◆ FirstResourceMemMip

int32 UTexture2D::FirstResourceMemMip

keep track of first mip level used for ResourceMem creation

◆ ResourceMem

FTexture2DResourceMem* UTexture2D::ResourceMem

memory used for directly loading bulk mip data


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