IVirtualizationSystem

The base interface for the virtualization system.

Choose your operating system:

Windows

macOS

Linux

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

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

Name Description

Public function

IVirtualizationSystem()

Destructors

Name Description

Public function Virtual

~IVirtualizationSystem()

Functions

Name Description

Public function

bool

 

DoPayloadsExist

(
    TArrayView< const FPayloadId > Ids,
    EStorageType StorageType,
    TArray< FPayloadStatus >& OutStatu...
)

Query if a number of payloads exist or not in the given storage type.

Public function Static

IVirtualizat...

 

Get()

Gain access to the current virtualization system active for the project

Public function Const

FPayloadActi...

 

GetAccumualtedPayloadActivityInfo()

Access profiling info relating to accumulated payload activity.

Public function

FOnNotificat...

 

GetNotificationEvent()

Public function Const

void

 

GetPayloadActivityInfo

Access profiling info relating to payload activity per backend.

Public function Const

bool

 

IsEnabled()

Poll to see if content virtualization is enabled or not.

Public function

FCompressedB...

 

PullData

(
    const FPayloadId& Id
)

Pull a 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

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

Push a payload to the virtualization backends.

Enums

Name

Description

Public enum

ENotification

Typedefs

Name

Description

FOnNotification

Declare delegate for notifications

GetPayloadActivityInfoFuncRef

See Also

VirtualizationManager