1. Epic GamesDeveloper
  3. MuR

MuR

API > API/Plugins > API/Plugins/MutableRuntime

Classes

  Type Name Description
Public class Base Base class from which all library classes inherit to control memory allocation. For internal use only.  
Public class box    
Public class ExtensionData    
Public class ExtensionDataStreamer Interface to allow the runtime to load ExtensionData for use.  
Public struct FBodyShape    
Public struct FBoxBody    
Public struct FConvexBody    
Public class FExtensionDataLoadHandle Allows runtime code to track the progress of an Extension Data load.  
Public struct FImageDesc    
Public struct FImageFormatData    
Public struct FImageMemoryCounterTag    
Public struct FImageOperator This struct contains image operations that may need to allocate and free temporary images to work.  
Public class FMemoryTrackingAllocatorWrapper    
Public class FMemoryTrackingAllocatorWrapper2    
Public struct FMeshBufferFormatData    
Public class FMeshBufferSet Set of buffers storing mesh element data. Elements can be vertices, indices or faces.  
Public struct FMeshMemoryCounterTag    
Public struct FMipmapGenerationSettings    
Public class FMutableRuntimeModule    
Public struct FPhysicsBodyAggregate    
Public struct FSphereBody    
Public struct FSphylBody    
Public struct FTaperedCapsuleBody    
Public class Image 2D image resource with mipmaps.  
Public class ImageParameterGenerator Interface to request external images used as parameters.  
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 mat Generic square matrix template.  
Public class mat3    
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 struct MESH_BUFFER    
Public struct MESH_BUFFER_CHANNEL    
Public struct MESH_SURFACE    
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 OutputMemoryStream    
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 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    
Public class ResourceProxyMemory    
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 struct TIsAMemoryCounter    
Public struct TMemoryCounter    
Public class vec Generic vector template.  
Public class vec2    
Public class vec3    

Typedefs

Name Description
ExtensionDataPtr  
ExtensionDataPtrConst  
FDefaultMemoryTrackingAllocator  
FDefaultMemoryTrackingBitArrayAllocator  
FDefaultMemoryTrackingSetAllocator  
FDefaultMemoryTrackingSparceArrayAllocator  
FImageMemoryCounter  
FImageRect  
FImageSize  
float16 16-bit floating point number support.
FMeshMemoryCounter  
ImagePtr  
ImagePtrConst  
InstancePtr  
InstancePtrConst  
LayoutPtr  
LayoutPtrConst  
mat3f  
mat4f  
MeshPtr  
MeshPtrConst  
ModelParametersGeneratorPtr  
ModelParametersGeneratorPtrConst  
ParametersPtr  
ParametersPtrConst  
PhysicsBodyPtr  
PhysicsBodyPtrConst  
RangeIndexPtr  
RangeIndexPtrConst  
SkeletonPtr  
SkeletonPtrConst  
SystemPtr  
SystemPtrConst  
vec2f  
vec3f  

Enums

  Type Name Description
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::EMeshBufferType This requires a separate plugin.  
Public enum mu::EMeshCopyFlags This requires a separate plugin.  
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::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::MESH_BUFFER_FORMAT Supported formats for the elements in mesh buffers.  
Public enum mu::MESH_BUFFER_SEMANTIC Semantics of the mesh buffers  
Public enum mu::PARAMETER_DETAILED_TYPE Additional information about a particular parameter type.  
Public enum mu::PARAMETER_TYPE Model parameter types.  
Public enum mu::PROJECTOR_TYPE Types of projectors.  

Functions

  Type Name Description
Public function T

mu::clamp ( const T mi,
const T ma,
const T v
)

  
Public function vec< SCALAR, DIM >

mu::clamp ( const vec< SCALAR, DIM >& v,
SCALAR mi,
SCALAR ma
)

  
Public function Ptr< T >

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

  
Public function vec3< SCALAR >

mu::cross ( const vec3< SCALAR >& a,
const vec3< SCALAR >& b
)

 Cross product of 3D vectors.
Public function SCALAR

mu::dot ( const vec< SCALAR, DIM >& a,
const vec< SCALAR, DIM >& b
)

 Dot product of 3D vectors.
Public function float16

mu::floatToHalf ( float i
)

  
Public function float16

mu::floatToHalfI ( uint32 i
)

  
Public function vec3f

mu::FromUnreal ( const FVector3f& v
)

  
Public function float  
Public function uint32  
Public function SCALAR

mu::length ( const vec< SCALAR, DIM >& v
)

 Length of a vector.
Public function vec< SCALAR, DIM >

mu::lerp ( const vec< SCALAR, DIM >& f0,
const vec< SCALAR, DIM >& f1,
float t
)

  
Public function void  
Public function void  
Public function vec< SCALAR, DIM >

mu::normalise ( const vec< SCALAR, DIM >& a
)

 Normalise a vector.
Public function vec< SCALAR, DIM >

mu::normalise_approx ( const vec< SCALAR, DIM >& a
)

 Normalise a vector, approximately.
Public function vec< SCALAR, DIM >

mu::normalise_unsafe ( const vec< SCALAR, DIM >& a
)

 Normalise a vector, assuming that its length won't be null.
Public function constexpr bool  
Public function constexpr bool  
Public function bool

mu::operator!= ( T* 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 constexpr EBoneUsageFlags  
Public function constexpr EMeshCopyFlags  
Public function EMeshCopyFlags &  
Public function EBoneUsageFlags &  
Public function constexpr EMeshCopyFlags  
Public function constexpr EBoneUsageFlags  
Public function EBoneUsageFlags &  
Public function EMeshCopyFlags &  
Public function constexpr EMeshCopyFlags  
Public function constexpr EBoneUsageFlags  
Public function EMeshCopyFlags &  
Public function EBoneUsageFlags &  
Public function constexpr EMeshCopyFlags  
Public function constexpr EBoneUsageFlags  
Public function bool

mu::operator== ( T* 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 void

mu::operator>> ( InputArchive& arch,
T& t
)

  
Public function void  
Public function void

mu::operator>> ( InputArchive& arch,
TArray< T, Alloc >& v
)

  
Public function bool

mu::point_in_face ( const FVector3f& InVtx,
const FVector3f& normal,
FVector3f vertices,
int& out_intersected_vert,
int& out_intersected_edge_v0,
int& out_intersected_edge_v1,
float point_in_plane_eps
)

  
Public function float

mu::point_to_plane_dist ( const FVector3f& point,
const FVector3f& plane_origin,
const FVector3f& plane_normal
)

 Point to plane distance.
Public function FVector3f

mu::ray_plane_intersection ( const FVector3f& ray_start,
const FVector3f& ray_end,
const FVector3f& plane_origin,
const FVector3f& plane_normal
)

 Ray plane intersection.
Public function bool

mu::ray_plane_intersection ( const FVector3f& ray_start,
const FVector3f& ray_end,
const FVector3f& plane_origin,
const FVector3f& plane_normal,
FVector3f& out_intersection,
float& out_t
)

  
Public function bool

mu::rayIntersectsFace ( const FVector3f& ray_start,
const FVector3f& ray_end,
const FVector3f& v0,
const FVector3f& v1,
const FVector3f& v2,
FVector3f& out_intersection,
int& out_intersected_vert,
int& out_intersected_edge_v0,
int& out_intersected_edge_v1,
float point_in_face_epsilon
)

  
Public function bool

mu::rayIntersectsFace2 ( const FVector3f& ray_start,
const FVector3f& ray_end,
const FVector3f& v0,
const FVector3f& v1,
const FVector3f& v2,
FVector3f& out_intersection,
int& out_intersected_vert,
int& out_intersected_edge_v0,
int& out_intersected_edge_v1,
float& out_t
)

  
Public function float

mu::rsqrt_approx ( float number
)

 Approximated inverse square root.
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 FMatrix44f

mu::ToUnreal ( const mat4f& m
)

 Temp while transitioning to UE math.
Public function FVector3f

mu::ToUnreal ( const vec3f& v
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page