Phriction Documentation Mutable Mutable for Unreal Engine Technical documentation Performance Report
This tool allows running a series of randomized tests to obtain information on which are the worst cases for several performance critical parameters, like texture memory usage, triangle count or instance update time.
For those worst cases, it allows obtaining a detailed report of all their textures as well as opening the Customizable Object Instance that produced those results, where you can inspect its parameters and its resulting skeletal mesh.
UsageThe arrow button on the right of the button "Generate Performance Report" allows configuring the tests.
The "Generate Performance Report" button starts the tests to retrieve data. They take several minutes to complete, but the information is updated as results keep coming in.
Currently, the Stress Tests retrieve only texture size and triangle amount data, and the State Tests retrieve only update time data. Once update time data becomes available, the button "Select the currently slowest instance" allows selecting and viewing the details on the slowest update time in the whole test. This button then becomes disabled, and is enabled again whenever an even slower instance is found.Once the tests start, you can see the results for each LOD. The average and difference in each row is only concerning that particular LOD.
At its top level, the update time results table presents the time that it takes to enter a State. Each state result row presents a little arrow that allows visualizing the times for changing parameters when said state was active. Only parameters defined for such state are tested. The result rows for parameters show how long it takes to update an instance after changing only said parameter randomly to one of it's valid values.
As with LODs, the averages and differences on the update time results table are only about the time that it took to enter that particular state or to change that particular parameter. By clicking any of the results row, you can see the information on that particular instance in the right side:
- The instance asset allows accessing the chosen instances' Editor by double clicking the icon. This gives access to the parameter values, skeletal mesh, skeleton, materials and textures as in any other Customizable Object Instance. This also allows baking the instance, if you are interested in keeping the resulting mesh and materials.
- The refresh button gets enabled whenever the chosen instance is not the worst on its category. For example, if we are reviewing the instance with the most geometry for LOD 2 and an instance with even more geometry is found for LOD 2.
- The Texture Analyzer for that particular instance: This shows information on all the mutable textures for all the LODs for the selected instance. The columns Texture, Name, Material and Parent are clickable and open the corresponding texture, material instance and base material.