init

app/plugins/fps_logger/fps_logger.cpp

@@ -0,0 +1,61 @@
+/* Copyright (c) 2020-2025, Arm Limited and Contributors
+ * Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
+ *
+ * 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.
+ */
+
+#include "fps_logger.h"
+
+namespace plugins
+{
+FpsLogger::FpsLogger() :
+    FpsLoggerTags("FPS Logger", "Enable FPS logging.", {vkb::Hook::OnUpdate, vkb::Hook::OnAppStart}, {}, {{"log-fps", "Log FPS"}})
+{
+}
+
+bool FpsLogger::handle_option(std::deque<std::string> &arguments)
+{
+	assert(!arguments.empty() && (arguments[0].substr(0, 2) == "--"));
+	std::string option = arguments[0].substr(2);
+	if (option == "log-fps")
+	{
+		arguments.pop_front();
+		return true;
+	}
+	return false;
+}
+
+void FpsLogger::on_update(float delta_time)
+{
+	if (!timer.is_running())
+	{
+		timer.start();
+	}
+
+	auto elapsed_time = static_cast<float>(timer.elapsed<vkb::Timer::Seconds>());
+
+	frame_count++;
+
+	if (elapsed_time > 0.5f)
+	{
+		auto fps = (frame_count - last_frame_count) / elapsed_time;
+
+		LOGI("FPS: {:.1f}", fps);
+
+		last_frame_count = frame_count;
+		timer.lap();
+	}
+};
+}        // namespace plugins

app/plugins/fps_logger/fps_logger.h

@@ -0,0 +1,51 @@
+/* Copyright (c) 2020-2025, Arm Limited and Contributors
+ * Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
+ *
+ * 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 "platform/plugins/plugin_base.h"
+
+namespace plugins
+{
+using FpsLoggerTags = vkb::PluginBase<vkb::tags::Passive>;
+
+/**
+ * @brief FPS Logger
+ *
+ * Control when FPS should be logged. Declutters the log output by removing FPS logs when not enabled
+ *
+ * Usage: vulkan_sample sample afbc --log-fps
+ *
+ */
+class FpsLogger : public FpsLoggerTags
+{
+  public:
+	FpsLogger();
+
+	virtual ~FpsLogger() = default;
+
+	void on_update(float delta_time) override;
+
+	bool handle_option(std::deque<std::string> &arguments) override;
+
+  private:
+	size_t     frame_count      = 0;
+	size_t     last_frame_count = 0;
+	vkb::Timer timer;
+};
+}        // namespace plugins