Programmers Guide » History » Version 11

« Previous - Version 11/27 (diff) - Next » - Current version
Jordi Rovira, 11/24/2016 10:20 AM

Programming Guide



The system is structured as an Unreal plugin with two additional Unreal modules: one for the editor and one for the runtime. These modules use external libraries for the Mutable runtime, which is a standalonw library with no dependencies.

Folder Structure

This is the basic folder structure of an Unreal Engine game that uses Mutable. The hierarchy only shows the relevant folders for Mutable source code.


The folder “source” is optional and it contains the source code of the standalone runtime and tools libraries. These are already included in the “lib” folder as precompiled binaries for each supported platform, with the required headers in the “include” folder. For the debug version, symbol pdb files are also included.


In case the source of the standalone libraries needs to be modified, a Visual Studio solution is included inside source->project->vs2015 to rebuild them. Both “release” and “debug” configurations should always be rebuilt to avoid desynchronising the binaries. After that the libraries and include files need to be updated using the script “DeployFromSource.bat” in the mutable folder.


The “source” folder may also contain the source code for the standalone tools for Mutable. These tools are not required for normal Mutable usage but they can be very helpful to debug and profile your project.

Internal Design

Mutable is designed around the concept of virtual machine. Customizable objects are decomposed in series of intructions that are optimised to build the instances on different situations. These instructions operate on mesh fragments, images and colours and they transform them by merging, blending, packaging texture coordinates etc.

The system relies heavily in a pre-process of the object graph that generates code for a virtual machine whose operations involve mesh fragments, images, etc. This object-construction code is then optimised for every use case of the model so that the optimal process to construct an instance is found.

Mutable standalone model debugger and profiler showing the virtual machine code, the set of constant data (image blocks and mesh fragments), a preview object and texture layout and a simulation of the parallel construction of a model with its memory usage.

Using customizable objects in game

Resource management