1. Epic GamesDeveloper
  3. MuR

MuR

API > API/Plugins > API/Plugins/MutableRuntime

Classes

  Type Name Description
Public class box    
Public class ExtensionData    
Public class ExtensionDataStreamer Interface to allow the runtime to load ExtensionData for use.  
Public class ExternalResourceProvider Interface to request external images used as parameters.  
Public struct FBodyShape    
Public struct FBoneName Bone name identifier.  
Public struct FBoxBody    
Public struct FConvexBody    
Public class FExtensionDataLoadHandle Allows runtime code to track the progress of an Extension Data load.  
Public struct FGlobalMemoryCounter    
Public class FImageDataStorage    
Public struct FImageDesc    
Public struct FImageFormatData    
Public struct FImageMemoryCounter    
Public struct FImageOperator This struct contains image operations that may need to allocate and free temporary images to work.  
Public struct FLayoutBlock    
Public struct FMeshBuffer    
Public struct FMeshBufferChannel    
Public struct FMeshBufferFormatData    
Public class FMeshBufferSet Set of buffers storing mesh element data. Elements can be vertices, indices or faces.  
Public struct FMeshMemoryCounter    
Public struct FMeshSurface    
Public struct FMipmapGenerationSettings    
Public class FMutableRuntimeModule    
Public class FMutableScopeTimer Simple class that saves the time the scope is alive in the given location.  
Public struct FPhysicsBodyAggregate    
Public struct FSphereBody    
Public struct FSphylBody    
Public struct FSurfaceSubMesh    
Public struct FTaperedCapsuleBody    
Public class Image 2D image resource with mipmaps.  
Public class InputArchive Archive containing data to be deserialised.  
Public class InputArchiveWithProxies    
Public class InputStream Interface for any input stream to be use with InputArchives.  
Public class Instance A customised object created from a model and a set of parameter values.  
Public class Layout Image block layout class.  
Public class Mesh Mesh object containing any number of buffers with any number of channels. The buffers can be per-index or per-vertex. The mesh also includes layout information for every texture channel for internal usage, and it can be ignored. The meshes are always assumed to be triangle list primitives.  
Public class Model A Model represents a customisable object with any number of parameters.  
Public class ModelParametersGenerator This class enumerates all possible model instances and generates the parameters for each of them.  
Public class ModelReader    
Public class ModelWriter    
Public class OutputArchive Archive where data can be serialised to.  
Public class OutputHashStream This stream doesn't store any data: it just calculates of a hash of the data as it receives it.  
Public class OutputMemoryStream    
Public class OutputSizeStream This stream doesn't store any data: it just counts the amount of data serialised.  
Public class OutputStream Interface for any output stream to be used with OutputArchives.  
Public class Parameters This class represents the parameters of a model including description, type and value, and additional resources associated to the parameter.  
Public class PhysicsBody    
Public class Ptr Intrusive smart pointer similar to the one in the boost libraries (intrusive_ptr<>)  
Public class RangeIndex Class used to set or read multi-dimensional parameter values. If parameters have multiple values because of ranges, RangeIndex can be used to specify what value is read or set in the methods of the Parameter class. RangeIndex objects can be reused in multiple calls for the same parameter in the Parameter class interface even after changing the position values.  
Public class RefCounted Base class for all reference counted objects.  
Public class Resource    
Public class ResourceProxy This repesents a handle to Mutable resource.  
Public class ResourceProxyMemory Proxy implementation that always has the resource loaded in memory.  
Public class Settings Settings class that can be used to create a customised System instance.  
Public class Skeleton Skeleton object.  
Public class String Container for text string data.  
Public class System Main system class to load models and build instances.  
Public class TMemoryTrackingAllocatorWrapper CounterType is expected to be of the following form, the alingas is needed to prevent type clashes between modules.  

Typedefs

Name Description
ExtensionDataPtr  
ExtensionDataPtrConst  
FDefaultMemoryTrackingAllocator Default memory tracking allocators needed for TArray and TMap.
FDefaultMemoryTrackingBitArrayAllocator  
FDefaultMemoryTrackingSetAllocator  
FDefaultMemoryTrackingSparceArrayAllocator  
FImageArray  
FImageRect  
FImageSize  
FResourceID Handle used to identify separate resources generated by mutable: images and meshes included in instances.
ImagePtr  
ImagePtrConst  
InstancePtr  
InstancePtrConst  
MeshPtr  
MeshPtrConst  
ModelParametersGeneratorPtr  
ModelParametersGeneratorPtrConst  
ParametersPtr  
ParametersPtrConst  
RangeIndexPtr  
RangeIndexPtrConst  
SkeletonPtr  
SkeletonPtrConst  
SystemPtr  
SystemPtrConst  

Enums

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

Functions

  Type Name Description
Public function uint32

GetTypeHash ( const TArray< T >& Key
)

  
Public function bool

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

  
Public function bool

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

  
Public function bool

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

  
Public function Ptr< T >

mu::CloneOrTakeOver ( const T* source
)

 Use with care.
Public function Ptr< T >

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

  
Public function Static const FVector4f

mu::DefaultMutableColorValue (

  • UE_BIG_NUMBER
    )
 Default parameter values definition.
Public function    
Public function    
Public function int32  
Public function int32  
Public function uint32

mu::GetTypeHash ( const FBoneName& Bone
)

  
Public function EImageFormat  
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function    
Public function void  
Public function void  
Public function bool

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

  
Public function bool

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

  
Public function bool

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

  
Public function bool

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

  
Public function bool

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

  
Public function bool

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

  
Public function void

mu::operator>> ( InputArchive& Arch,
FUintVector2& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
FIntVector2& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
UE::Math::TIntVector2< uint16 >& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
UE::Math::TIntVector2< int16 >& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
int8& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
FVector4f& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
uint64& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
FMatrix44f& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
FRichCurveKey& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
FVector2f& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
uint32& T
)

  
Public function void

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

  
Public function void

mu::operator>> ( InputArchive& Arch,
uint8& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
int64& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
int32& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
int16& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
double& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
float& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
Type& Value
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
FGuid& T
)

  
Public function void

mu::operator>> ( InputArchive& Arch,
uint16& T
)

  
Public function Ptr< T >

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

  
Public function void

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

  
Public function bool

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

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page