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

#include <RuntimeVirtualTexture.h>

+ Inheritance diagram for URuntimeVirtualTexture:

Classes

struct  FInitSettings
 

Public Member Functions

ERuntimeVirtualTextureMaterialType GetMaterialType () const
 
int32 GetTileCount () const
 
int32 GetTileSize () const
 
int32 GetTileBorderSize () const
 
int32 GetSize () const
 
ENGINE_API int32 GetPageTableSize () const
 
bool GetCompressTextures () const
 
bool GetClearTextures () const
 
bool GetSinglePhysicalSpace () const
 
bool GetPrivateSpace () const
 
bool GetAdaptivePageTable () const
 
bool GetContinuousUpdate () const
 
int32 GetRemoveLowMips () const
 
bool GetLQCompression () const
 
FVector4f GetCustomMaterialData () const
 
TEnumAsByte< enum TextureGroupGetLODGroup () const
 
ENGINE_API void GetProducerDescription (FVTProducerDescription &OutDesc, FInitSettings const &InitSettings, FTransform const &VolumeToWorld) const
 
ENGINE_API int32 GetLayerCount () const
 
ENGINE_API EPixelFormat GetLayerFormat (int32 LayerIndex) const
 
ENGINE_API bool IsLayerSRGB (int32 LayerIndex) const
 
ENGINE_API bool IsLayerYCoCg (int32 LayerIndex) const
 
 DECLARE_DELEGATE (FOnReInitDelegate)
 
ENGINE_API void Initialize (IVirtualTexture *InProducer, FVTProducerDescription const &InProducerDesc, FTransform const &InVolumeToWorld, FBox const &InWorldBounds, FOnReInitDelegate InDelegate)
 
ENGINE_API void Initialize (IVirtualTexture *InProducer, FVTProducerDescription const &InProducerDesc, FTransform const &InVolumeToWorld, FBox const &InWorldBounds)
 
ENGINE_API void Release ()
 
ENGINE_API FVirtualTextureProducerHandle GetProducerHandle () const
 
ENGINE_API IAllocatedVirtualTextureGetAllocatedVirtualTexture () const
 
ENGINE_API FVector4 GetUniformParameter (int32 Index) const
 
ENGINE_API EVTProducerPriority GetPriority () const
 
ENGINE_API EVTProducerPriority GetDefaultPriority () const
 
bool GetUseCustomPriority () 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 PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
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 BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
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 bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
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
 
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 int32 GetClampedTileCount (int32 InTileCount, bool InAdaptive)
 
static ENGINE_API int32 GetMaxTileCountLog2 (bool InAdaptive)
 
static int32 GetClampedTileSize (int32 InTileSize)
 
static ENGINE_API int32 GetLayerCount (ERuntimeVirtualTextureMaterialType InMaterialType)
 
static ENGINE_API UE::Shader::EValueType GetUniformParameterType (int32 Index)
 
- 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)
 

Protected Member Functions

ENGINE_API void InitResource (IVirtualTexture *InProducer, FVTProducerDescription const &InProducerDesc)
 
ENGINE_API void InitNullResource ()
 
virtual ENGINE_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const override
 
virtual ENGINE_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const override
 
virtual ENGINE_API void PostLoad () override
 
- 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

int32 TileCount = 8
 
int32 TileSize = 2
 
int32 TileBorderSize = 2
 
ERuntimeVirtualTextureMaterialType MaterialType = ERuntimeVirtualTextureMaterialType::BaseColor_Normal_Specular
 
bool bCompressTextures = true
 
bool bUseLowQualityCompression = false
 
EVTProducerPriority CustomPriority
 
bool bUseCustomPriority = false
 
bool bClearTextures = true
 
bool bSinglePhysicalSpace = true
 
bool bPrivateSpace = true
 
bool bAdaptive = false
 
bool bContinuousUpdate = false
 
int32 RemoveLowMips = 0
 
FVector4f CustomMaterialData
 
TEnumAsByte< enum TextureGroupLODGroup = TEXTUREGROUP_World
 
int32 Size_DEPRECATED = -1
 
TObjectPtr< class URuntimeVirtualTextureStreamingProxyStreamingTexture_DEPRECATED = nullptr
 

Friends

class FRuntimeVirtualTextureDetailsCustomization
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 

Detailed Description

Runtime virtual texture UObject

Member Function Documentation

◆ DECLARE_DELEGATE()

URuntimeVirtualTexture::DECLARE_DELEGATE ( FOnReInitDelegate  )

Declare a delegate funtion signiture for a function that is registered in Initialize() to be called if we call Initialize() without calling Release(). This can happen for the case where the RuntimeVirtualTexture is registered twice. For example in PIE and the main editor. In that case we want to notify the first caller.

◆ GetAdaptivePageTable()

bool URuntimeVirtualTexture::GetAdaptivePageTable ( ) const
inline

Public getter for virtual texture using adaptive flag.

◆ GetAllocatedVirtualTexture()

IAllocatedVirtualTexture * URuntimeVirtualTexture::GetAllocatedVirtualTexture ( ) const

Getter for the associated virtual texture allocation. Call on render thread only.

◆ GetAssetRegistryTags() [1/2]

void URuntimeVirtualTexture::GetAssetRegistryTags ( FAssetRegistryTagsContext  Context) const
overrideprotectedvirtual

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 URuntimeVirtualTexture::GetAssetRegistryTags ( TArray< FAssetRegistryTag > &  OutTags) const
overrideprotectedvirtual

Reimplemented from UObject.

◆ GetClampedTileCount()

static int32 URuntimeVirtualTexture::GetClampedTileCount ( int32  InTileCount,
bool  InAdaptive 
)
inlinestatic

◆ GetClampedTileSize()

static int32 URuntimeVirtualTexture::GetClampedTileSize ( int32  InTileSize)
inlinestatic

◆ GetClearTextures()

bool URuntimeVirtualTexture::GetClearTextures ( ) const
inline

Returns true if texture pages should be cleared before render

◆ GetCompressTextures()

bool URuntimeVirtualTexture::GetCompressTextures ( ) const
inline

Get if this virtual texture uses compressed texture formats.

◆ GetContinuousUpdate()

bool URuntimeVirtualTexture::GetContinuousUpdate ( ) const
inline

Public getter for virtual texture using continuous update flag.

◆ GetCustomMaterialData()

FVector4f URuntimeVirtualTexture::GetCustomMaterialData ( ) const
inline

Public getter for the custom material data.

◆ GetDefaultPriority()

EVTProducerPriority URuntimeVirtualTexture::GetDefaultPriority ( ) const

◆ GetLayerCount() [1/2]

int32 URuntimeVirtualTexture::GetLayerCount ( ) const

Returns number of texture layers in the virtual texture

◆ GetLayerCount() [2/2]

int32 URuntimeVirtualTexture::GetLayerCount ( ERuntimeVirtualTextureMaterialType  InMaterialType)
static

Returns number of texture layers in the virtual texture of a given material type

◆ GetLayerFormat()

EPixelFormat URuntimeVirtualTexture::GetLayerFormat ( int32  LayerIndex) const

Returns the texture format for the virtual texture layer

◆ GetLODGroup()

TEnumAsByte< enum TextureGroup > URuntimeVirtualTexture::GetLODGroup ( ) const
inline

Public getter for texture LOD Group

◆ GetLQCompression()

bool URuntimeVirtualTexture::GetLQCompression ( ) const
inline

Public getter for virtual texture using low quality compression flag.

◆ GetMaterialType()

ERuntimeVirtualTextureMaterialType URuntimeVirtualTexture::GetMaterialType ( ) const
inline

Get the material set that this virtual texture stores.

◆ GetMaxTileCountLog2()

int32 URuntimeVirtualTexture::GetMaxTileCountLog2 ( bool  InAdaptive)
static

◆ GetPageTableSize()

int32 URuntimeVirtualTexture::GetPageTableSize ( ) const

Public getter for virtual texture page table size. This is only different from GetTileCount() when using an adaptive page table.

◆ GetPriority()

EVTProducerPriority URuntimeVirtualTexture::GetPriority ( ) const

◆ GetPrivateSpace()

bool URuntimeVirtualTexture::GetPrivateSpace ( ) const
inline

Public getter for virtual texture using private space flag.

◆ GetProducerDescription()

void URuntimeVirtualTexture::GetProducerDescription ( FVTProducerDescription OutDesc,
FInitSettings const &  InitSettings,
FTransform const &  VolumeToWorld 
) const

Get virtual texture description based on the properties of this object and the passed in volume transform.

◆ GetProducerHandle()

FVirtualTextureProducerHandle URuntimeVirtualTexture::GetProducerHandle ( ) const

Getter for the associated virtual texture producer. Call on render thread only.

◆ GetRemoveLowMips()

int32 URuntimeVirtualTexture::GetRemoveLowMips ( ) const
inline

Public getter for virtual texture removed low mips

◆ GetSinglePhysicalSpace()

bool URuntimeVirtualTexture::GetSinglePhysicalSpace ( ) const
inline

Public getter for virtual texture using single physical space flag.

◆ GetSize()

int32 URuntimeVirtualTexture::GetSize ( ) const
inline

Public getter for virtual texture size. This is derived from the TileCount and TileSize.

◆ GetTileBorderSize()

int32 URuntimeVirtualTexture::GetTileBorderSize ( ) const
inline

Public getter for virtual texture tile border size

◆ GetTileCount()

int32 URuntimeVirtualTexture::GetTileCount ( ) const
inline

Public getter for virtual texture tile count

◆ GetTileSize()

int32 URuntimeVirtualTexture::GetTileSize ( ) const
inline

Public getter for virtual texture tile size

◆ GetUniformParameter()

FVector4 URuntimeVirtualTexture::GetUniformParameter ( int32  Index) const

Getter for the shader uniform parameters.

◆ GetUniformParameterType()

UE::Shader::EValueType URuntimeVirtualTexture::GetUniformParameterType ( int32  Index)
static

Getter for the shader uniform parameter type.

◆ GetUseCustomPriority()

bool URuntimeVirtualTexture::GetUseCustomPriority ( ) const
inline

◆ Initialize() [1/2]

void URuntimeVirtualTexture::Initialize ( IVirtualTexture InProducer,
FVTProducerDescription const &  InProducerDesc,
FTransform const &  InVolumeToWorld,
FBox const &  InWorldBounds 
)

◆ Initialize() [2/2]

void URuntimeVirtualTexture::Initialize ( IVirtualTexture InProducer,
FVTProducerDescription const &  InProducerDesc,
FTransform const &  InVolumeToWorld,
FBox const &  InWorldBounds,
FOnReInitDelegate  InDelegate 
)

(Re)Initialize this object. Call this whenever we modify the producer or transform.

◆ InitNullResource()

void URuntimeVirtualTexture::InitNullResource ( )
protected

Initialize the render resources with a null producer. This kicks off render thread work.

◆ InitResource()

void URuntimeVirtualTexture::InitResource ( IVirtualTexture InProducer,
FVTProducerDescription const &  InProducerDesc 
)
protected

Initialize the render resources. This kicks off render thread work.

◆ IsLayerSRGB()

bool URuntimeVirtualTexture::IsLayerSRGB ( int32  LayerIndex) const

Return true if the virtual texture layer should be sampled as sRGB

◆ IsLayerYCoCg()

bool URuntimeVirtualTexture::IsLayerYCoCg ( int32  LayerIndex) const

Return true if the virtual texture layer should be sampled as YCoCg

◆ PostLoad()

void URuntimeVirtualTexture::PostLoad ( )
overrideprotectedvirtual

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.

◆ Release()

void URuntimeVirtualTexture::Release ( )

Release the resources for this object This will need to be called if our producer becomes stale and we aren't doing a full reinit with a new producer.

Friends And Related Symbol Documentation

◆ FRuntimeVirtualTextureDetailsCustomization

friend class FRuntimeVirtualTextureDetailsCustomization
friend

Member Data Documentation

◆ bAdaptive

bool URuntimeVirtualTexture::bAdaptive = false
protected

Enable sparse adaptive page tables. This supports larger tile counts but adds an indirection cost when sampling the virtual texture. It is recommended only when very large virtual resolutions are necessary.

◆ bClearTextures

bool URuntimeVirtualTexture::bClearTextures = true
protected

Enable clear before rendering a page of the virtual texture. Disabling this can be an optimization if you know that the texture will always be fully covered by rendering.

◆ bCompressTextures

bool URuntimeVirtualTexture::bCompressTextures = true
protected

Enable storing the virtual texture in GPU supported compression formats. Using uncompressed is only recommended for debugging and quality comparisons.

◆ bContinuousUpdate

bool URuntimeVirtualTexture::bContinuousUpdate = false
protected

Enable continuous update of the virtual texture pages. This round-robin updates already mapped pages and can help fix pages that are mapped before dependent textures are fully streamed in.

◆ bPrivateSpace

bool URuntimeVirtualTexture::bPrivateSpace = true
protected

Enable private page table allocation. This can reduce total page table memory allocation but can also reduce the total number of virtual textures supported.

◆ bSinglePhysicalSpace

bool URuntimeVirtualTexture::bSinglePhysicalSpace = true
protected

Enable page table channel packing. This reduces page table memory and update cost but can reduce the ability to share physical memory with other virtual textures.

◆ bUseCustomPriority

bool URuntimeVirtualTexture::bUseCustomPriority = false
protected

◆ bUseLowQualityCompression

bool URuntimeVirtualTexture::bUseLowQualityCompression = false
protected

Use low quality textures (RGB565/RGB555A1) to replace runtime compression

◆ CustomMaterialData

FVector4f URuntimeVirtualTexture::CustomMaterialData
protected

A float4 custom value that can be read in the material that writes this virtual texture.

◆ CustomPriority

EVTProducerPriority URuntimeVirtualTexture::CustomPriority
protected

Allows to override the default priority that this runtime virtual texture has, relative to other virtual texture producers. This allows to get the pages from this virtual texture to update faster than others in case of high contention.

◆ LODGroup

TEnumAsByte<enum TextureGroup> URuntimeVirtualTexture::LODGroup = TEXTUREGROUP_World
protected

Texture group this texture belongs to

◆ MaterialType

ERuntimeVirtualTextureMaterialType URuntimeVirtualTexture::MaterialType = ERuntimeVirtualTextureMaterialType::BaseColor_Normal_Specular
protected

Contents of virtual texture.

◆ RemoveLowMips

int32 URuntimeVirtualTexture::RemoveLowMips = 0
protected

Number of low mips to cut from the virtual texture. This can reduce peak virtual texture update cost but will also increase the probability of mip shimmering.

◆ Size_DEPRECATED

int32 URuntimeVirtualTexture::Size_DEPRECATED = -1
protected

Deprecated size of virtual texture.

◆ StreamingTexture_DEPRECATED

TObjectPtr<class URuntimeVirtualTextureStreamingProxy> URuntimeVirtualTexture::StreamingTexture_DEPRECATED = nullptr
protected

Deprecated texture object containing streamed low mips.

◆ TileBorderSize

int32 URuntimeVirtualTexture::TileBorderSize = 2
protected

Page tile border size divided by 2 (Actual values increase in multiples of 2). Higher values trigger a higher anisotropic sampling level.

◆ TileCount

int32 URuntimeVirtualTexture::TileCount = 8
protected

Size of virtual texture in tiles. (Actual values increase in powers of 2). This is applied to the largest axis in world space and the size for any shorter axis is chosen to maintain aspect ratio.

◆ TileSize

int32 URuntimeVirtualTexture::TileSize = 2
protected

Page tile size. (Actual values increase in powers of 2)


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