106 lines
2.5 KiB
C++
106 lines
2.5 KiB
C++
/* Copyright (c) 2020-2025, Broadcom Inc. and Contributors
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 the "License";
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "common/vk_common.h"
|
|
#include "stats_common.h"
|
|
|
|
namespace vkb
|
|
{
|
|
namespace core
|
|
{
|
|
template <vkb::BindingType bindingType>
|
|
class CommandBuffer;
|
|
using CommandBufferC = CommandBuffer<vkb::BindingType::C>;
|
|
} // namespace core
|
|
|
|
/**
|
|
* @brief Abstract interface for all StatsProvider classes
|
|
*/
|
|
class StatsProvider
|
|
{
|
|
public:
|
|
struct Counter
|
|
{
|
|
double result;
|
|
};
|
|
|
|
using Counters = std::unordered_map<StatIndex, Counter, StatIndexHash>;
|
|
|
|
/**
|
|
* @brief Virtual Destructor
|
|
*/
|
|
virtual ~StatsProvider()
|
|
{}
|
|
|
|
/**
|
|
* @brief Checks if this provider can supply the given enabled stat
|
|
* @param index The stat index
|
|
* @return True if the stat is available, false otherwise
|
|
*/
|
|
virtual bool is_available(StatIndex index) const = 0;
|
|
|
|
/**
|
|
* @brief Retrieve graphing data for the given enabled stat
|
|
* @param index The stat index
|
|
*/
|
|
virtual const StatGraphData &get_graph_data(StatIndex index) const
|
|
{
|
|
return default_graph_map.at(index);
|
|
}
|
|
|
|
/**
|
|
* @brief Retrieve default graphing data for the given stat
|
|
* @param index The stat index
|
|
*/
|
|
static const StatGraphData &default_graph_data(StatIndex index);
|
|
|
|
/**
|
|
* @brief Retrieve a new sample set
|
|
* @param delta_time Time since last sample
|
|
*/
|
|
virtual Counters sample(float delta_time) = 0;
|
|
|
|
/**
|
|
* @brief Retrieve a new sample set from continuous sampling
|
|
* @param delta_time Time since last sample
|
|
*/
|
|
virtual Counters continuous_sample(float delta_time)
|
|
{
|
|
return Counters();
|
|
}
|
|
|
|
/**
|
|
* @brief A command buffer that we want stats about has just begun
|
|
* @param cb The command buffer
|
|
*/
|
|
virtual void begin_sampling(vkb::core::CommandBufferC &cb)
|
|
{}
|
|
|
|
/**
|
|
* @brief A command buffer that we want stats about is about to be ended
|
|
* @param cb The command buffer
|
|
*/
|
|
virtual void end_sampling(vkb::core::CommandBufferC &cb)
|
|
{}
|
|
|
|
protected:
|
|
static std::map<StatIndex, StatGraphData> default_graph_map;
|
|
};
|
|
} // namespace vkb
|