1. Epic GamesDeveloper
  3. MuT

MuT

API > API/Plugins > API/Plugins/MutableTools

Classes

  Type Name Description
Public class Compiler This utility class compiles two types of expressions: models and transforms.  
Public class CompilerOptions Options used to compile the models with a compiler.  
Public class ErrorLog Class used to store the error, warning and information messages from several processes performed by the tools library, like model transformation or compilation.  
Public struct ErrorLogMessageAttachedDataView    
Public class FileModelWriter Implementation of the streaming interface that actually loads the file synchronously when needed.  
Public class FMutableToolsModule    
Public struct FNodeType Information about the type of a node, to provide some means to the tools to deal generically with nodes.  
Public struct FObjectState Information about an object state in the source data.  
Public struct FStateOptimizationOptions    
Public class InputFileStream Read a file into a serialisation stream.  
Public class Node Base class for all graphs used in the source data to define models and transforms.  
Public class NodeBool Base class of any node that outputs a Bool value.  
Public class NodeBoolAnd    
Public class NodeBoolConstant Node returning a Bool constant value.  
Public class NodeBoolNot Node that returns the oposite of the input value.  
Public class NodeBoolParameter Node that defines a Bool model parameter.  
Public class NodeColour Base class of any node that outputs a colour.  
Public class NodeColourArithmeticOperation Perform a per-component arithmetic operation between two colours.  
Public class NodeColourConstant This node outputs a predefined colour value.  
Public class NodeColourFromScalars Obtain a colour by sampling an image at specific homogeneous coordinates.  
Public class NodeColourParameter Node that defines a colour model parameter.  
Public class NodeColourSampleImage Obtain a colour by sampling an image at specific homogeneous coordinates.  
Public class NodeColourSwitch This node selects an output Colour from a set of input Colours based on a parameter.  
Public class NodeColourTable This node provides the meshes stored in the column of a table.  
Public class NodeColourVariation    
Public class NodeComponent This class is the parent of all nodes that output a component.  
Public class NodeComponentEdit This node modifies a node of the parent object of the object that this node belongs to.  
Public class NodeComponentNew This node makes a new component from several meshes and images.  
Public class NodeExtensionData Node that evaluates to an ExtensionData  
Public class NodeExtensionDataConstant Node that outputs a constant ExtensionData  
Public class NodeExtensionDataSwitch    
Public class NodeExtensionDataVariation    
Public class NodeImage Base class of any node that outputs an image.  
Public class NodeImageBinarise Node that multiplies the colors of an image, channel by channel.  
Public class NodeImageColourMap This node changes the colours of a selectd part of the image, applying a colour map from conteined in another image.  
Public class NodeImageConditional This node selects an output image from a set of input images based on a parameter.  
Public class NodeImageConstant Node that outputs a constant image.  
Public class NodeImageFormat Node that composes a new image by gathering pixel data from channels in other images.  
Public class NodeImageGradient This node generats an horizontal linear gradient between two colours in a new image.  
Public class NodeImageInterpolate Node that interpolates linearly between several images based on a weight.  
Public class NodeImageInvert Node that inverts the colors of an image, channel by channel  
Public class NodeImageLayer This node applies a layer blending effect on a base image using a mask and a blended image.  
Public class NodeImageLayerColour This node applies a layer blending effect on a base image using a mask and a colour.  
Public class NodeImageLuminance Calculate the luminance of an image into a new single-channel image..  
Public class NodeImageMipmap Generate mimaps for an image.  
Public class NodeImageMultiLayer This node applies any numbre of layer blending effect on a base image using a mask and a blended image.  
Public class NodeImageNormalComposite Node that inverts the colors of an image, channel by channel  
Public class NodeImageParameter Node that defines a Image model parameter.  
Public class NodeImagePlainColour Node that multiplies the colors of an image, channel by channel.  
Public class NodeImageProject    
Public class NodeImageResize Node that multiplies the colors of an image, channel by channel.  
Public class NodeImageSaturate Change the saturation of an image.  
Public class NodeImageSwitch This node selects an output image from a set of input images based on a parameter.  
Public class NodeImageSwizzle Node that composes a new image by gathering pixel data from channels in other images.  
Public class NodeImageTable This node provides the meshes stored in the column of a table.  
Public class NodeImageTransform Node that multiplies the colors of an image, channel by channel.  
Public class NodeImageVariation    
Public class NodeLayout This node is used to define the texture layout for a texture coordinates channel of a constant mesh.  
Public class NodeLayoutBlocks This node is used to define the texture layout for a texture coordinates channel of a constant mesh.  
Public class NodeLOD Node that creates a new level of detail by assembling several object components.  
Public class NodeMesh Base class of any node that outputs a mesh.  
Public class NodeMeshApplyPose Node that applies a pose to a mesh, baking it into the vertex data  
Public class NodeMeshClipDeform    
Public class NodeMeshClipMorphPlane This node applies a geometric transform represented by a 4x4 matrix to a mesh  
Public class NodeMeshClipWithMesh This node applies a geometric transform represented by a 4x4 matrix to a mesh  
Public class NodeMeshConstant Node that outputs a constant mesh.  
Public class NodeMeshFormat This node can change the buffer formats of a mesh vertices, indices and faces.  
Public class NodeMeshFragment This node selects a fragment of a mesh, by selecting some of its layout blocks.  
Public class NodeMeshGeometryOperation Node that morphs a base mesh with one or two weighted targets from a sequence.  
Public class NodeMeshInterpolate Node that morphs (interpolates linearly) between several meshes based on a weight.  
Public class NodeMeshMakeMorph This node removes from a mesh A all the faces that are also part of a mesh B.  
Public class NodeMeshMorph Node that morphs a base mesh with one weighted target.  
Public class NodeMeshReshape Node that morphs a base mesh with one or two weighted targets from a sequence.  
Public class NodeMeshSwitch This node selects an output Mesh from a set of input Meshs based on a parameter.  
Public class NodeMeshTable This node provides the meshes stored in the column of a table.  
Public class NodeMeshTangents This node rebuilds the tangents and binormals of the source mesh.  
Public class NodeMeshTransform This node applies a geometric transform represented by a 4x4 matrix to a mesh  
Public class NodeMeshVariation    
Public class NodeModifier This class is the parent of all nodes that output a component.  
Public class NodeModifierMeshClipDeform This node makes a new component from several meshes and images.  
Public class NodeModifierMeshClipMorphPlane This node makes a new component from several meshes and images.  
Public class NodeModifierMeshClipWithMesh This node makes a new component from several meshes and images.  
Public class NodeModifierMeshClipWithUVMask This node makes a new component from several meshes and images.  
Public class NodeObject Base class for any node that outputs an object.  
Public class NodeObjectGroup Node that creates a group of objects and describes how they are selected.  
Public class NodeObjectNew Node that creates a new object by setting its levels-of-detail and its children.  
Public class NodePatchMesh    
Public class NodeProjector Base class of any node that outputs a Projector.  
Public class NodeProjectorConstant This node outputs a predefined Projector value.  
Public class NodeProjectorParameter Node that defines a Projector model parameter.  
Public class NodeRange Base class of any node that outputs a range.  
Public class NodeRangeFromScalar    
Public class NodeScalar Base class of any node that outputs a scalar value.  
Public class NodeScalarArithmeticOperation Perform an arithmetic operation between two scalars.  
Public class NodeScalarConstant Node returning a scalar constant value.  
Public class NodeScalarCurve This node makes a new scalar value transforming another scalar value with a curve.  
Public class NodeScalarEnumParameter Node that defines a scalar model parameter to be selected from a set of named values.  
Public class NodeScalarParameter Node that defines a scalar model parameter.  
Public class NodeScalarSwitch This node selects an output Scalar from a set of input Scalars based on a parameter.  
Public class NodeScalarTable This node provides the meshes stored in the column of a table.  
Public class NodeScalarVariation    
Public class NodeString Base class of any node that outputs a string value.  
Public class NodeStringConstant Node returning a string constant value.  
Public class NodeStringParameter Node that defines a string model parameter.  
Public class NodeSurface This class is the parent of all nodes that output a Surface.  
Public class NodeSurfaceEdit This node modifies a node of the parent object of the object that this node belongs to.  
Public class NodeSurfaceNew This node makes a new Surface from several meshes and images.  
Public class NodeSurfaceSwitch This node selects an output Surface from a set of input Surfaces based on a parameter.  
Public class NodeSurfaceVariation This node modifies a node of the parent object of the object that this node belongs to.  
Public class OutputFileStream Write a serialisation stream to a file.  
Public class ProxyFactoryMutableSourceFile ProxyFactory that provides proxies for data stored in a mutable_source file.  
Public class Table A table that contains many rows and defines attributes like meshes, images, colours, etc.  
Public class TypeInfo    

Typedefs

Name Description
CompilerPtr  
CompilerPtrConst  
ErrorLogPtr  
ErrorLogPtrConst  
FReferencedResourceFunc  
FReferencedResourceGameThreadTickFunc  
ModelPtr  
ModelPtrConst  
NodeColourArithmeticOperationPtr  
NodeColourArithmeticOperationPtrConst  
NodeColourConstantPtr  
NodeColourConstantPtrConst  
NodeColourFromScalarsPtr  
NodeColourFromScalarsPtrConst  
NodeColourParameterPtr  
NodeColourParameterPtrConst  
NodeColourPtr  
NodeColourPtrConst  
NodeColourSampleImagePtr  
NodeColourSampleImagePtrConst  
NodeColourSwitchPtr  
NodeColourSwitchPtrConst  
NodeColourTablePtr  
NodeColourTablePtrConst  
NodeColourVariationPtr  
NodeColourVariationPtrConst  
NodeComponentEditPtr  
NodeComponentEditPtrConst  
NodeComponentNewPtr  
NodeComponentNewPtrConst  
NodeComponentPtr  
NodeComponentPtrConst  
NodeExtensionDataConstantPtr  
NodeExtensionDataConstantPtrConst  
NodeExtensionDataPtr  
NodeExtensionDataPtrConst  
NodeExtensionDataSwitchPtr  
NodeExtensionDataSwitchPtrConst  
NodeExtensionDataVariationPtr  
NodeExtensionDataVariationPtrConst  
NodeImageBinarisePtr  
NodeImageBinarisePtrConst  
NodeImageColourMapPtr  
NodeImageColourMapPtrConst  
NodeImageConditionalPtr  
NodeImageConditionalPtrConst  
NodeImageConstantPtr  
NodeImageConstantPtrConst  
NodeImageFormatPtr  
NodeImageFormatPtrConst  
NodeImageGradientPtr  
NodeImageGradientPtrConst  
NodeImageInterpolatePtr  
NodeImageInterpolatePtrConst  
NodeImageInvertPtr  
NodeImageInvertPtrConst  
NodeImageLayerColourPtr  
NodeImageLayerColourPtrConst  
NodeImageLayerPtr  
NodeImageLayerPtrConst  
NodeImageLuminancePtr  
NodeImageLuminancePtrConst  
NodeImageMipmapPtr  
NodeImageMipmapPtrConst  
NodeImageMultiLayerPtr  
NodeImageMultiLayerPtrConst  
NodeImageNormalCompositePtr  
NodeImageNormalCompositePtrConst  
NodeImagePlainColourPtr  
NodeImagePlainColourPtrConst  
NodeImageResizePtr  
NodeImageResizePtrConst  
NodeImageSaturatePtr  
NodeImageSaturatePtrConst  
NodeImageSwitchPtr  
NodeImageSwitchPtrConst  
NodeImageSwizzlePtr  
NodeImageSwizzlePtrConst  
NodeImageTablePtr  
NodeImageTablePtrConst  
NodeImageTransformPtr  
NodeImageTransformPtrConst  
NodeImageVariationPtr  
NodeImageVariationPtrConst  
NodeLayoutBlocksPtr  
NodeLayoutBlocksPtrConst  
NodeLayoutPtr  
NodeLayoutPtrConst  
NodeLODPtr  
NodeLODPtrConst  
NodeMapPtr  
NodeMapPtrConst  
NodeMeshApplyPosePtr  
NodeMeshApplyPosePtrConst  
NodeMeshClipMorphPlaneConst  
NodeMeshClipMorphPlanePtr  
NodeMeshClipWithMeshConst  
NodeMeshClipWithMeshPtr  
NodeMeshConstantPtr  
NodeMeshConstantPtrConst  
NodeMeshFormatPtr  
NodeMeshFormatPtrConst  
NodeMeshFragmentPtr  
NodeMeshFragmentPtrConst  
NodeMeshGeometryOperationPtr  
NodeMeshGeometryOperationPtrConst  
NodeMeshInterpolatePtr  
NodeMeshInterpolatePtrConst  
NodeMeshMakeMorphPtr  
NodeMeshMakeMorphPtrConst  
NodeMeshPtr  
NodeMeshPtrConst  
NodeMeshSwitchPtr  
NodeMeshSwitchPtrConst  
NodeMeshTablePtr  
NodeMeshTablePtrConst  
NodeMeshTangentsPtr  
NodeMeshTangentsPtrConst  
NodeMeshTransformPtr  
NodeMeshTransformPtrConst  
NodeMeshVariationPtr  
NodeMeshVariationPtrConst  
NodeModifierConst  
NodeModifierMeshClipDeformPtr  
NodeModifierMeshClipDeformPtrConst  
NodeModifierMeshClipMorphPlanePtr  
NodeModifierMeshClipMorphPlanePtrConst  
NodeModifierPtr  
NodeModifierPtrConst  
NodeObjectGroupPtr  
NodeObjectGroupPtrConst  
NodeObjectPtr  
NodeObjectPtrConst  
NodePatchMeshPtr  
NodePatchMeshPtrConst  
NodeProjectorConstantPtr  
NodeProjectorConstantPtrConst  
NodeProjectorParameterPtr  
NodeProjectorParameterPtrConst  
NodeProjectorPtr  
NodeProjectorPtrConst  
NodePtr  
NodePtrConst  
NodeRangePtr  
NodeRangePtrConst  
NodeScalarArithmeticOperationPtr  
NodeScalarArithmeticOperationPtrConst  
NodeScalarConstantPtr  
NodeScalarConstantPtrConst  
NodeScalarCurvePtr  
NodeScalarCurvePtrConst  
NodeScalarEnumParameterPtr  
NodeScalarEnumParameterPtrConst  
NodeScalarParameterPtr  
NodeScalarParameterPtrConst  
NodeScalarPtr  
NodeScalarPtrConst  
NodeScalarSwitchPtr  
NodeScalarSwitchPtrConst  
NodeScalarTablePtr  
NodeScalarTablePtrConst  
NodeScalarVariationPtr  
NodeScalarVariationPtrConst  
NodeStringConstantPtr  
NodeStringConstantPtrConst  
NodeStringParameterPtr  
NodeStringParameterPtrConst  
NodeStringPtr  
NodeStringPtrConst  
NodeSurfaceEditPtr  
NodeSurfaceEditPtrConst  
NodeSurfaceNewPtr  
NodeSurfaceNewPtrConst  
NodeSurfacePtr  
NodeSurfacePtrConst  
NodeSurfaceSwitchPtr  
NodeSurfaceSwitchPtrConst  
NodeSurfaceVariationPtr  
NodeSurfaceVariationPtrConst  
TablePtr  
TablePtrConst  
TransformPtr  
TransformPtrConst  

Enums

  Type Name Description
Public enum UEnum EMutableMultipleTagPolicy Despite being an UEnum, this is not always version-serialized (in MutableTools).  
Public enum mu::ETableColumnType Types of the values for the table cells.  

Functions

  Type Name Description
Public function void  
Public function void

ImageCoreToMutable ( const FCompressedImage2D& Compressed,
mu::Image* Mutable,
int32 LOD
)

  
Public function void

MutableToImageCore ( const mu::Image* InMutable,
FImage& CoreImage,
int32 LOD
)

  
Public function void This function needs to be called from the game thread before any call to UnrealPixelFormatFunc can be done.
Public function mu::EImageFormat Function that remaps some formats to the ones that provide more acceptable quality in Mutable.
Public function void

UnrealPixelFormatFunc ( bool& bOutSuccess,
int32 Quality,
mu::Image* Target,
const mu::Image* Source,
int32 OnlyLOD
)

 Try to convert an image using unreal's compression.
Public function mu::EImageFormat

UnrealToMutablePixelFormat ( EPixelFormat PlatformFormat,
bool bHasAlpha
)

 Convert an Unreal platform pixel format to Mutable.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page