1. Epic GamesDeveloper
  3. MutableRuntime

MutableRuntime

API > API/Plugins

   
Name MutableRuntime
Type Runtime
Part of Plugins Mutable
Location /Engine/Plugins/Mutable/Source/MutableRuntime/
Module Build Rules MutableRuntime.Build.cs

Classes

Name Remarks
box  
FExtensionData ExtensionData represents data types that Mutable doesn't support natively.
FExternalResourceProvider Interface to request external images used as parameters.
FImage 2D image resource with mipmaps.
FImageDataStorage  
FInputArchive Archive containing data to be deserialised.
FInputStream Interface for any input stream to be use with InputArchives.
FInstance A customised object created from a model and a set of parameter values.
FLayout Image block layout class.
FMesh Mesh object containing any number of buffers with any number of channels.
FMeshBufferSet Set of buffers storing mesh element data. Elements can be vertices, indices or faces.
FModel A Model represents a customisable object with any number of parameters.
FModelReader  
FModelWriter  
FMutableRuntimeModule  
FMutableScopeTimer Simple class that saves the time the scope is alive in the given location.
FOutputArchive Archive where data can be serialised to.
FOutputHashStream This stream doesn't store any data: it just calculates of a hash of the data as it receives it.
FOutputMemoryStream  
FOutputSizeStream This stream doesn't store any data: it just counts the amount of data serialised.
FOutputStream Interface for any output stream to be used with OutputArchives.
FParameters This class represents the parameters of a model including description, type and value, and additional resources associated to the parameter.
FPhysicsBody  
FRangeIndex Type used to set or read multi-dimensional parameter values.
FResource  
FSettings Settings class that can be used to create a customised System instance.
FSkeleton Skeleton object.
FSystem Main system class to load models and build instances.
Ptr Intrusive smart pointer similar to the one in the boost libraries (intrusive_ptr<>)
RefCounted Base class for all reference counted objects.
String Container for text string data.
TMemoryTrackingAllocatorWrapper CounterType is expected to be of the following form.
TResourceProxy This repesents a handle to Mutable resource.
TResourceProxyMemory Proxy implementation that always has the resource loaded in memory.

Structs

Name Remarks
FBodyShape  
FBoneName Bone name identifier.
FBoxBody  
FConvexBody  
FExtendedImageDesc An image descriptor with information about missing data LODs and which images are needed to load to generate the image
FGlobalMemoryCounter  
FImageDesc  
FImageFormatData  
FImageMemoryCounter  
FImageOperator This struct contains image operations that may need to allocate and free temporary images to work.
FLayoutBlock  
FMeshBuffer  
FMeshBufferChannel  
FMeshBufferFormatData  
FMeshMemoryCounter  
FMeshSurface  
FMipmapGenerationSettings  
FPhysicsBodyAggregate  
FSphereBody  
FSphylBody  
FSurfaceSubMesh  
FTaperedCapsuleBody  
FTriangleInfo Helper structs for mesh utility methods below.

Typedefs

Name Type Remarks Include Path
FDefaultMemoryTrackingAllocator TMemoryTrackingAllocatorWrapper< FDefaultAllocator, CounterType > Default memory tracking allocators needed for TArray and TMap. MuR/MemoryTrackingAllocationPolicy.h
FDefaultMemoryTrackingBitArrayAllocator TInlineAllocator< 4, FDefaultMemoryTrackingAllocator< CounterType > >   MuR/MemoryTrackingAllocationPolicy.h
FDefaultMemoryTrackingSetAllocator TSetAllocator< FDefaultMemoryTrackingSparceArrayAllocator< CounterType >, TInlineAllocator< 1, FDefaultMemoryTrackingAllocator< CounterType > >, 2, 8, 4 >   MuR/MemoryTrackingAllocationPolicy.h
FDefaultMemoryTrackingSparceArrayAllocator TSparseArrayAllocator< FDefaultMemoryTrackingAllocator< CounterType >, FDefaultMemoryTrackingBitArrayAllocator< CounterType > >   MuR/MemoryTrackingAllocationPolicy.h
FImageArray TArray< uint8, FDefaultMemoryTrackingAllocator< MemoryCounters::FImageMemoryCounter > >   MuR/ImageDataStorage.h
FImageRect box< FImageSize >   MuR/ImageTypes.h
FImageSize UE::Math::TIntVector2< uint16 >   MuR/ImageTypes.h
FResourceID uint64 Handle used to identify separate resources generated by mutable: images and meshes included in instances. MuR/Types.h

Enums

Public

Name Remarks
EClipVertexSelectionType This type is used in some mesh clip operations.
EFaceCullStrategy This type is used in some mesh clip operations.
ETextureCompressionStrategy Despite being an UEnum, this is not always version-serialized (in MutableTools).
mu::EAddressMode This requires a separate plugin.
mu::EBlendType List of supported modes in generic image layering operations.
mu::EBoneUsageFlags This requires a separate plugin.
mu::ECompositeImageMode This requires a separate plugin.
mu::EExecutionStrategy This requires a separate plugin.
mu::EImageFormat Pixel formats supported by the images.
mu::EInitializationType This requires a separate plugin.
mu::EMemoryInitPolicy This requires a separate plugin.
mu::EMeshBufferFormat Supported formats for the elements in mesh buffers.
mu::EMeshBufferSemantic Semantics of the mesh buffers
mu::EMeshBufferSetFlags This requires a separate plugin.
mu::EMeshBufferType This requires a separate plugin.
mu::EMeshContentFlags This requires a separate plugin.
mu::EMeshCopyFlags This requires a separate plugin.
mu::EMeshFlags Optimised mesh formats that are identified in some operations to chose a faster version.
mu::EMinFilterMethod This requires a separate plugin.
mu::EMipmapFilterType This requires a separate plugin.
mu::EPackStrategy Types of layout packing strategies.
mu::EParameterType Model parameter types.
mu::EProjectorType Types of 3D projectors.
mu::EReductionMethod Types of layout reduction methods.
mu::ESamplingMethod This requires a separate plugin.
mu::EShapeBindingMethod This requires a separate plugin.
mu::EVertexColorUsage This requires a separate plugin.

Functions

Public

Name Remarks Include Path Unreal Specifiers

uint32 GetTypeHash ( const TArray< T >& Key
)

   MuR/Types.h  

bool mu::AllGreaterOrEqualThan ( const VECTOR& v0,
const VECTOR& v1
)

   MuR/MutableMath.h  

bool mu::AllSmallerOrEqualThan ( const VECTOR& v0,
const VECTOR& v1
)

   MuR/MutableMath.h  

bool mu::AllSmallerThan ( const VECTOR& v0,
const VECTOR& v1
)

   MuR/MutableMath.h  

TSharedPtr< T > mu::CloneOrTakeOver ( const TSharedPtr< T >& Source
)

   MuR/Image.h  

TSharedPtr< T > mu::CloneOrTakeOver ( const TSharedPtr< const T >& Source
)

   MuR/Image.h  

Ptr< T > mu::const_pointer_cast ( Ptr< U > const& p
)

   MuR/Ptr.h  

int32 mu::FImageDataStorageInternal::ComputeNumLODsForSize ( FImageSize Size
)

   MuR/ImageDataStorage.h  

int32 mu::GetDim()

   MuR/MutableMath.h  

uint32 mu::GetTypeHash ( const FBoneName& Bone
)

   MuR/Skeleton.h  

EImageFormat mu::GetUncompressedFormat ( EImageFormat Format
)

   MuR/Image.h  
  MuR/ImageTypes.h  
  MuR/ImageTypes.h  
  MuR/ImageTypes.h  
  MuR/ImageTypes.h  
  MuR/ImageTypes.h  
  MuR/ImageTypes.h  
  MuR/ImageTypes.h  
  MuR/MeshBufferSet.h  
  MuR/MeshBufferSet.h  
  MuR/MeshBufferSet.h  
  MuR/Layout.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  
  MuR/Layout.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  

void mu::mutable_ptr_add_ref ( const RefCounted* p
)

   MuR/RefCounted.h  

void mu::mutable_ptr_release ( const RefCounted* p
)

   MuR/RefCounted.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  

bool mu::operator!= ( Ptr< T > const& a,
Ptr< U > const& b
)

   MuR/Ptr.h  

bool mu::operator!= ( Ptr< T > const& a,
U* b
)

   MuR/Ptr.h  

bool mu::operator!= ( T* a,
Ptr< U > const& b
)

   MuR/Ptr.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/Mesh.h  
  MuR/MeshBufferSet.h  

bool mu::operator== ( Ptr< T > const& a,
Ptr< U > const& b
)

   MuR/Ptr.h  

bool mu::operator== ( Ptr< T > const& a,
U* b
)

   MuR/Ptr.h  

bool mu::operator== ( T* a,
Ptr< U > const& b
)

   MuR/Ptr.h  

void mu::operator>> ( FInputArchive& Arch,
Type& Value
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
float& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
double& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
int8& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
int16& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
int32& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
int64& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
uint8& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
uint16& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
uint32& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
uint64& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
FUintVector2& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
FIntVector2& T
)

   MuR/Serialisation.h  
  MuR/Serialisation.h  
  MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
FVector2f& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
FVector4f& T
)

   MuR/Serialisation.h  

void mu::operator>> ( mu::FInputArchive& Arch,
FMatrix44f& T
)

   MuR/Serialisation.h  
  MuR/Serialisation.h  
  MuR/Serialisation.h  

void mu::operator>> ( FInputArchive& Arch,
TArray< T, Alloc >& V
)

   MuR/Serialisation.h  

Ptr< T > mu::static_pointer_cast ( Ptr< U > const& p
)

   MuR/Ptr.h  

void mu::swap ( Ptr< T >& lhs,
Ptr< T >& rhs
)

   MuR/Ptr.h  

MUTABLE_DEFINE_ENUM_SERIALISABLE ( ETextureCompressionStrategy
)

   MuR/System.h  

bool operator== ( const TMap< K, V >& A,
const TMap< K, V >& B
)

   MuR/Types.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page