Results

There are multiple ways to get and evaluate the results of the benchmark process.

Active Measurement

Get Active Measurement returns the data currently being recorded. The Return Value is false if there is no benchmark in progress.

Get Benchmark Result

After the benchmark has finished the results can be queried from the system.

Export JSON

The resulting data can be exported as a JSON file. The Save function is not tied to the active or previous benchmark and allows the export of any Benchmark Result struct.

The resulting file will have this format.

{
    "date": "YYYY.MM.DD-hh.mm.ss",
    "cpuName": "Cpu Name",
    "cpuCores": 8,
    "gpuName": "Graphics Card Name",
    "ramSizeGb": 32,
    "screenResolution":
    {
        "x": 1920,
        "y": 1080
    },
    "deviceId": "MAC Address if available",
    "comment": "Optional comment that can be added to the benchmark",
    "metaData":
    {
        "abritrary" : "data",
        "key" : "value map"
    },
    "measurements": [
        {
            "label": "Measurement Label 1",
            "averageFPS": 59.64076042175293,
            "minFPS": 5.3958039283752441,
            "maxFPS": 58.999998092651367,
            "fPS": [ 5.3958039283752441, 59.999998092651367, [...], 59.999998092651367 ]
        },
        {
            "label": "Scene B",
            "averageFPS": 59.64076042175293,
            "minFPS": 5.3958039283752441,
            "maxFPS": 58.999998092651367,
            "fPS": [ 5.3958039283752441, 59.999998092651367, [...], 59.999998092651367 ]
        }
    ]
}

Benchmark data can also be loaded from a JSON file into a struct using the Load Benchmark from Json File function.

Editor Utility Widget

To quickly analyze benchmark results the plugin provides an Editor Utility Widget that can load benchmark json files and display them. To run the widget Enable Plugin Content in the content browser and
go to Plugins -> FreetimeStudio Benchmark Content -> Editor. Right-click on the EUW_AnalyzeBenchmark widget and choose Run Editor Utility Widget.

The widget can load single benchmark json files or whole folders with multiple files. The clear button removes the loaded data.

Each section of a benchmark measurement is visualized with their label, the min and max and average FPS alongside a graph covering the entire recorded data.