MutableTools


Name	MutableTools
Type	Plugin
Part of Plugins	Mutable
Location	/Engine/Plugins/Mutable/Source/MutableTools/
Module Build Rules	MutableTools.Build.cs

Name	Remarks
Compiler
CompilerOptions	Options used to compile the models with a compiler.
FErrorLog	Storage for mutable error, warning and information messages from several processes performed by the tools library, like compilation.
FMutableToolsModule
FTable	A table that contains many rows and defines attributes like meshes, images, colours, etc.
Node	Base class for all graphs used in the source data to define models and transforms.
NodeBool	Base class of any node that outputs a Bool value.
NodeBoolAnd
NodeBoolConstant	Node returning a Bool constant value.
NodeBoolNot	Node that returns the oposite of the input value.
NodeBoolParameter	Node that defines a Bool model parameter.
NodeColour	Base class of any node that outputs a colour.
NodeColourArithmeticOperation	Perform a per - component arithmetic operation between two colours.
NodeColourConstant	This node outputs a predefined colour value.
NodeColourFromScalars	Obtain a colour by sampling an image at specific homogeneous coordinates.
NodeColourParameter	Node that defines a colour model parameter.
NodeColourSampleImage	Obtain a colour by sampling an image at specific homogeneous coordinates.
NodeColourSwitch	This node selects an output Colour from a set of input Colours based on a parameter.
NodeColourTable	This node provides the meshes stored in the column of a table.
NodeColourVariation	Select different color subgraphs based on active tags.
NodeComponent
NodeComponentEdit	This node modifies a node of the parent object of the object that this node belongs to.
NodeComponentNew
NodeComponentSwitch	This node selects an output component from a set of input components based on a parameter.
NodeComponentVariation	Select different component subgraphs based on active tags.
NodeExtensionData	Node that evaluates to an ExtensionData.
NodeExtensionDataConstant	Node that outputs a constant ExtensionData
NodeExtensionDataSwitch
NodeExtensionDataVariation
NodeImage	Base class of any node that outputs an image.
NodeImageBinarise	Node that multiplies the colors of an image, channel by channel.
NodeImageColourMap	This node changes the colours of a selectd part of the image, applying a colour map from conteined in another image.
NodeImageConditional	This node selects an output image from a set of input images based on a parameter.
NodeImageConstant	Node that outputs a constant image.
NodeImageFormat	Node that composes a new image by gathering pixel data from channels in other images.
NodeImageInterpolate	Node that interpolates linearly between several images based on a weight.
NodeImageInvert	Node that inverts the colors of an image, channel by channel.
NodeImageLayer	This node applies a layer blending effect on a base image using a mask and a blended image.
NodeImageLayerColour	This node applies a layer blending effect on a base image using a mask and a colour.
NodeImageLuminance	Calculate the luminance of an image into a new single - channel image.
NodeImageMipmap	Generate mimaps for an image.
NodeImageMultiLayer	This node applies any numbre of layer blending effect on a base image using a mask and a blended image.
NodeImageNormalComposite	Node that inverts the colors of an image, channel by channel.
NodeImageParameter
NodeImagePlainColour	Node that multiplies the colors of an image, channel by channel.
NodeImageProject
NodeImageResize	Node that multiplies the colors of an image, channel by channel.
NodeImageSaturate	Change the saturation of an image.This node can be used to increase the saturation with a factor bigger than 1, or to decrease it or desaturate it completely with a factor smaller than 1 or 0.
NodeImageSwitch	This node selects an output image from a set of input images based on a parameter.
NodeImageSwizzle	Node that composes a new image by gathering pixel data from channels in other images.
NodeImageTable	This node provides the meshes stored in the column of a table.
NodeImageTransform
NodeImageVariation
NodeLayout	This node is used to define the texture layout for a texture coordinates channel of a mesh.
NodeLOD
NodeMatrix	Base class of any node that outputs a colour.
NodeMatrixConstant
NodeMatrixParameter
NodeMesh	Base class of any node that outputs a mesh.
NodeMeshApplyPose	Node that applies a pose to a mesh, baking it into the vertex data.
NodeMeshClipDeform
NodeMeshClipMorphPlane	This node applies a geometric transform represented by a 4x4 matrix to a mesh.
NodeMeshClipWithMesh	This node applies a geometric transform represented by a 4x4 matrix to a mesh
NodeMeshConstant	Node that outputs a constant mesh.
NodeMeshFormat	This node can change the buffer formats of a mesh vertices, indices and faces.
NodeMeshFragment	This node extracts a fragment of a mesh by some selection on a texture layout space.
NodeMeshMakeMorph	This node removes from a mesh A all the faces that are also part of a mesh B.
NodeMeshMorph	Node that morphs a base mesh with one weighted target.
NodeMeshParameter
NodeMeshReshape	Node that morphs a base mesh with one or two weighted targets from a sequence.
NodeMeshSwitch	This node selects an output Mesh from a set of input Meshs based on a parameter.
NodeMeshTable	This node provides the meshes stored in the column of a table.
NodeMeshTransform	This node applies a geometric transform represented by a 4x4 matrix to a mesh.
NodeMeshVariation
NodeModifier	Parent of all node classes that apply modifiers to surfaces.
NodeModifierMeshClipDeform
NodeModifierMeshClipMorphPlane
NodeModifierMeshClipWithMesh
NodeModifierMeshClipWithUVMask	This node can clip part of a mesh using UV space-data (an image or a list of layout blocks).
NodeModifierMeshTransformInMesh
NodeModifierSurfaceEdit	This node modifies a surface node.
NodeObject	Base class for any node that outputs an object.
NodeObjectGroup	Node that creates a group of objects and describes how they are selected.
NodeObjectNew	Node that creates a new object by setting its levels-of-detail and its children.
NodeProjector	Base class of any node that outputs a Projector.
NodeProjectorConstant	This node outputs a predefined Projector value.
NodeProjectorParameter	Node that defines a Projector model parameter.
NodeRange	Base class of any node that outputs a range.
NodeRangeFromScalar
NodeScalar	Base class of any node that outputs a scalar value.
NodeScalarArithmeticOperation	Perform an arithmetic operation between two scalars.
NodeScalarConstant	Node returning a scalar constant value.
NodeScalarCurve	This node makes a new scalar value transforming another scalar value with a curve.
NodeScalarEnumParameter	Node that defines a scalar model parameter to be selected from a set of named values.
NodeScalarParameter	Node that defines a scalar model parameter.
NodeScalarSwitch	This node selects an output Scalar from a set of input Scalars based on a parameter.
NodeScalarTable	This node provides the meshes stored in the column of a table.
NodeScalarVariation
NodeString	Base class of any node that outputs a string value.
NodeStringConstant	Node returning a string constant value.
NodeStringParameter	Node that defines a string model parameter.
NodeSurface	This class is the parent of all nodes that output a Surface.
NodeSurfaceNew	This node makes a new Surface (Mesh Material Section) from a mesh and several material parameters like images, vectors and scalars.
NodeSurfaceSwitch	This node selects an output Surface from a set of input Surfaces based on a parameter.
NodeSurfaceVariation	This node modifies a node of the parent object of the object that this node belongs to.
TypeInfo

Name	Remarks
ErrorLogMessageAttachedDataView
FClipMorphPlaneParameters
FObjectState	Information about an object state in the source data.
FSourceDataDescriptor	Data related to the a source image that is necessary to classify the final image and mesh fragments that are derived from this source.
FSourceLayoutBlock	Data for a layout block before it is compiled.
FStateOptimizationOptions

Name	Type	Remarks	Include Path
FNodeType	Node::FNodeType		MuT/Node.h
FReferencedImageResourceFunc	TFunction< UE::Tasks::FTask(int32, TSharedPtr< TSharedPtr< FImage > >, bool)>	Arguments are Texture ID, output generated texture and a "run immediately" flag.	MuT/Compiler.h
FReferencedMeshResourceFunc	TFunction< UE::Tasks::FTask(int32, const FString &, TSharedPtr< TSharedPtr< FMesh > >, bool)>	Arguments are	MuT/Compiler.h
NodeImagePtr	Ptr< NodeImage >		MuT/NodeImage.h
NodeImagePtrConst	Ptr< const NodeImage >		MuT/NodeImage.h
NodeMapPtr	Ptr< NodeMap >		MuT/Node.h
NodeMapPtrConst	Ptr< const NodeMap >		MuT/Node.h
NodeMeshPtr	Ptr< NodeMesh >		MuT/NodeMesh.h
NodeMeshPtrConst	Ptr< const NodeMesh >		MuT/NodeMesh.h
NodeModifierConst	Ptr< const NodeModifier >		MuT/NodeModifier.h
NodeModifierPtr	Ptr< NodeModifier >		MuT/NodeModifier.h
NodePtr	Ptr< Node >		MuT/Node.h
NodePtrConst	Ptr< const Node >		MuT/Node.h
NodeSurfacePtr	Ptr< NodeSurface >		MuT/NodeSurface.h
NodeSurfacePtrConst	Ptr< const NodeSurface >		MuT/NodeSurface.h
TransformPtr	Ptr< Transform >		MuT/Compiler.h
TransformPtrConst	Ptr< const Transform >		MuT/Compiler.h

Name	Remarks
EMutableMultipleTagPolicy	Despite being an UEnum, this is not always version-serialized (in MutableTools).
mu::ErrorLogMessageSpamBin	Categories of message stored in the log for the purpose of limiiting duplication of non - identical messages.
mu::ErrorLogMessageType	Types of message stored in the log.
mu::ETableColumnType	Types of the values for the table cells.

Name	Remarks	Include Path
void DebugImageDump ( const mu::FImage* Image, const FString& FilePath )	Debug export the given image to a temp file in the saved folder.	MuT/UnrealPixelFormatOverride.h
void FillBuildSettingsFromMutableFormat ( FTextureBuildSettings& Settings, bool& bOutHasAlpha, mu::EImageFormat Format )		MuT/UnrealPixelFormatOverride.h
bool ImageCoreToMutable ( const FCompressedImage2D& Compressed, mu::FImage* Mutable, int32 LOD )		MuT/UnrealPixelFormatOverride.h
void MutableToImageCore ( const mu::FImage* InMutable, FImage& CoreImage, int32 LOD, bool bSwizzleRGBHack )		MuT/UnrealPixelFormatOverride.h
void PrepareUnrealCompression()	This function needs to be called from the game thread before any call to UnrealPixelFormatFunc can be done.	MuT/UnrealPixelFormatOverride.h
mu::EImageFormat QualityAndPerformanceFix ( mu::EImageFormat Format )	Function that remaps some formats to the ones that provide more acceptable quality in Mutable.	MuT/UnrealPixelFormatOverride.h
void UnrealPixelFormatFunc ( bool& bOutSuccess, int32 Quality, mu::FImage* Target, const mu::FImage* Source, int32 OnlyLOD )	Try to convert an image using unreal's compression.	MuT/UnrealPixelFormatOverride.h
mu::EImageFormat UnrealToMutablePixelFormat ( EPixelFormat PlatformFormat, bool bHasAlpha )	Convert an Unreal platform pixel format to Mutable.	MuT/UnrealPixelFormatOverride.h

Navigation

Classes

Structs

Typedefs

Enums

Public

Functions

Public