Navigation
API > API/Plugins > API/Plugins/MutableRuntime
Main system class to load models and build instances.
| Name | FSystem |
| Type | class |
| Header File | /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/System.h |
| Include Path | #include "MuR/System.h" |
Syntax
class FSystem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| MuR/System.h | |||
| Prevent copy, move and assignment. | MuR/System.h | ||
| Constructor of a system object to build data. | MuR/System.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FSystem() |
MuR/System.h |
Classes
| Name | Remarks |
|---|---|
| Private |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AllLODs | uint32 | This constant can be used in place of the lodMask in methods like BeginUpdate. | MuR/System.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| m_pD | Private * | MuR/System.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< const FInstance > BeginUpdate
(
FInstance::FID InstanceID, |
Update an instance with a new parameter set and/or state. | MuR/System.h | |
void ClearWorkingMemory () |
Removes all the possible working memory regardless of the budget set. | MuR/System.h | |
void EndUpdate
(
FInstance::FID InstanceID |
Invalidate and free the last Instance data returned by a call to BeginUpdate with the same instance index. | MuR/System.h | |
UE::Tasks::TTask< TSharedPtr< const FImage > > GetImage
(
FInstance::FID InstanceID, |
Only valid between BeginUpdate and EndUpdate | MuR/System.h | |
UE::Tasks::TTask< FExtendedImageDesc > GetImageDesc
(
FInstance::FID InstanceID, |
Only valid between BeginUpdate and EndUpdate Calculate the description of an image, without generating it. | MuR/System.h | |
FExtendedImageDesc GetImageDescInline
(
FInstance::FID InstanceID, |
Only valid between BeginUpdate and EndUpdate Calculate the description of an image, without generating it. | MuR/System.h | |
TSharedPtr< const FImage > GetImageInline
(
FInstance::FID InstanceID, |
Only valid between BeginUpdate and EndUpdate | MuR/System.h | |
UE::Tasks::TTask< TSharedPtr< const FMesh > > GetMesh
(
FInstance::FID InstanceID, |
Only valid between BeginUpdate and EndUpdate. | MuR/System.h | |
TSharedPtr< const FMesh > GetMeshInline
(
FInstance::FID InstanceID, |
Only valid between BeginUpdate and EndUpdate. | MuR/System.h | |
void GetParameterRelevancy
(
FInstance::FID InstanceID, |
Calculate the relevancy of every parameter. | MuR/System.h | |
Private * GetPrivate() |
MuR/System.h | ||
FInstance::FID NewInstance
(
const TSharedPtr< const FModel >& Model |
Create a new instance from the given model. | MuR/System.h | |
void ReleaseInstance
(
FInstance::FID InstanceID |
Completely destroy an instance. | MuR/System.h | |
void SetExternalResourceProvider
(
const TSharedPtr< FExternalResourceProvider >& |
Set a new provider for external image data. | MuR/System.h | |
void SetGeneratedCacheSize
(
uint32 InCount |
Set the amount of generated resources keys that will be stored for resource reusal. | MuR/System.h | |
void SetImagePixelConversionOverride
(
const FImageOperator::FImagePixelFormatFunc& |
Set a function that will be used to convert image pixel formats instead of the internal conversion. | MuR/System.h | |
void SetStreamingInterface
(
const TSharedPtr< FModelReader >& |
Set a new provider for model data. | MuR/System.h | |
void SetWorkingMemoryBytes
(
uint64 Bytes |
Set the working memory limit, overrding any set in the settings when the system was created. | MuR/System.h |