o3de/Code/Framework/AzToolsFramework/Tests/Prefab/Benchmark/SpawnableCreateBenchmarks.cpp

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */
#if defined(HAVE_BENCHMARK)

#include <Prefab/Benchmark/PrefabBenchmarkFixture.h>

#include <AzToolsFramework/Prefab/Spawnable/SpawnableUtils.h>

namespace Benchmark
{
    using BM_SpawnableCreate = BM_Prefab;
    using namespace AzToolsFramework::Prefab;

    BENCHMARK_DEFINE_F(BM_SpawnableCreate, CreateSpawnable_SingleEntityInstance)(::benchmark::State& state)
    {
        const unsigned int numSpawnables = static_cast<unsigned int>(state.range());

        AZStd::unique_ptr<Instance> instance(m_prefabSystemComponent->CreatePrefab(
            { CreateEntity("Entity1") },
            {},
            m_pathString));


        auto& prefabDom = m_prefabSystemComponent->FindTemplateDom(instance->GetTemplateId());
        for ([[maybe_unused]] auto _ : state)
        {
            // Create a vector to store spawnables so that they don't get destroyed immediately after construction.
            AZStd::vector<AZStd::unique_ptr<AzFramework::Spawnable>> spawnables;
            spawnables.reserve(numSpawnables);
            
            for (unsigned int spwanableCounter = 0; spwanableCounter < numSpawnables; ++spwanableCounter)
            {
                AZStd::unique_ptr<AzFramework::Spawnable> spawnable = AZStd::make_unique<AzFramework::Spawnable>();
                AzToolsFramework::Prefab::SpawnableUtils::CreateSpawnable(*spawnable, prefabDom);
                spawnables.push_back(AZStd::move(spawnable));
            }
        }

        state.SetComplexityN(numSpawnables);
    }
    BENCHMARK_REGISTER_F(BM_SpawnableCreate, CreateSpawnable_SingleEntityInstance)
        ->RangeMultiplier(10)
        ->Range(100, 10000)
        ->Unit(benchmark::kMillisecond)
        ->Complexity();
}

#endif