Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. IVirtualizationSystem

IVirtualizationSystem

The base interface for the virtualization system.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Virtualization

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Virtualization/VirtualizationSystem.h
Include #include "Virtualization/VirtualizationSystem.h"

Syntax

class IVirtualizationSystem

Remarks

The base interface for the virtualization system. An Epic maintained version can be found in the Virtualization module. To implement your own, simply derived from this interface and then use the UE_REGISTER_VIRTUALIZATION_SYSTEM macro in the cpp to register it as an option. You can then set the config file option [Core.ContentVirtualization]SystemName=FooBar, where FooBar should be the SystemName parameter you used when registering with the macro.

Special Cases: SystemName=Off - This is the default set up and means a project will not use content virtualization Note that calling IVirtualizationSystem::Get() will still return a valid IVirtualizationSystem implementation, but all push and pull operations will result in failure and IsEnabled will always return false. SystemName=Default - This will cause the default Epic implementation to be used

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const bool Poll to see if the virtualization process failing when submitting a collection of files to source control should block that submit or allow it to continue.
Public function bool

DoPayloadsExist ( TArrayView< const FIoHash > Ids,
EStorageType StorageType,
TArray< EPayloadStatus >& OutStatuses
)

  
Public function Const void When called the system should write any performance stats that it has been gathering to the log file
Public function Const EPayloadFilterReason

FilterPayload ( const UObject* Owner
)

 Run checks to see if the payload can be virtualized or not.
Public function Const void

GatherAnalytics ( TArray< FAnalyticsEventAttribute >& Attributes
)

 Gather analytics data. Stats will only be collected if ENABLE_COOK_STATS is enabled.
Public function Static IVirtualizationSystem &

Get ()

 Gain access to the current virtualization system active for the project.
Public function Virtual Const FPayloadActivityInfo  
Public function Const TArray< FBackendStats > Access profiling info relating to payload activity per backend.
Public function FOnNotification &  
Public function Virtual Const void  
Public function Static FName Returns the name of the currently initialized system, will be NAME_None if initialization failed or the system is not enabled
Public function Const FPayloadActivityInfo Access profiling info for all backends combined.
Public function bool

Initialize ( const FInitParams& InitParams
)

 Initialize the system from the parameters given in the FInitParams structure.
Public function Const bool Poll to see if content virtualization is enabled or not.
Public function Static bool Returns true if a virtualization system has been initialized and false if not
Public function Const bool

IsPushingEnabled ( EStorageType StorageType
)

 Poll to see if pushing virtualized content to the given backend storage type is enabled or not.
Public function bool

PullData ( TArrayView< FPullRequest > Requests
)

 Pull a number of payloads from the virtualization backends.
Public function FCompressedBuffer

PullData ( const FIoHash& Id
)

 Pull a single payload from the virtualization backends.
Public function bool

PullData ( FPullRequest Request
)

 Pull a single payload from the virtualization backends.
Public function bool

PushData ( TArrayView< FPushRequest > Requests,
EStorageType StorageType
)

 Push one or more payloads to a backend storage system.
Public function bool

PushData ( FPushRequest Request,
EStorageType StorageType
)

 Push a payload to the virtualization backends.
Public function bool

PushData ( const FIoHash& Id,
const FCompressedBuffer& Payload,
const FString& Context,
EStorageType StorageType
)

 Push a payload to the virtualization backends.
Public function bool

PushData ( const FIoHash& Id,
const FCompressedBuffer& Payload,
EStorageType StorageType,
const FString& Context
)

  
Public function EQueryResult

QueryPayloadStatuses ( TArrayView< const FIoHash > Ids,
EStorageType StorageType,
TArray< EPayloadStatus >& OutStatuses
)

 Query if a number of payloads exist or not in the given storage type.
Public function Virtual ERehydrationResult

TryRehydratePackages ( TConstArrayView< FString > PackagePaths,
TArray< FText >& OutErrors
)

  
Public function FRehydrationResult

TryRehydratePackages ( TConstArrayView< FString > PackagePaths,
ERehydrationOptions Options
)

 Runs the rehydration process on a set of packages.
Public function ERehydrationResult

TryRehydratePackages ( TConstArrayView< FString > PackagePaths,
uint64 PaddingAlignment,
TArray< FText >& OutErrors,
TArray< FSharedBuffer >& OutPackages,
TArray< FRehydrationInfo >* OutInfo
)

 Rehydrates a number of packages into memory buffers.
Public function FVirtualizationResult

TryVirtualizePackages ( TConstArrayView< FString > PackagePaths,
EVirtualizationOptions Options
)

 Runs the virtualization process on a set of packages.
Public function Virtual EVirtualizationResult

TryVirtualizePackages ( TConstArrayView< FString > PackagePaths,
TArray< FText >& OutDescriptionTags,
TArray< FText >& OutErrors
)

  

Enums

  Type Name Description
Public enum ENotification    

Typedefs

Name Description
FOnNotification Declare delegate for notifications
GetPayloadActivityInfoFuncRef  

See Also

VirtualizationManager

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page