VSync無効時にフレームレートを制限する機能を追加

Linux/CMakeLists.txt

@@ -300,6 +300,8 @@ set(SIV3D_INTERNAL_SOURCES
   ../Siv3D/src/Siv3D/FormatInt/SivFormatInt.cpp
   ../Siv3D/src/Siv3D/Formatter/SivFormatter.cpp
   ../Siv3D/src/Siv3D/FormatUtility/SivFormatUtility.cpp
+  ../Siv3D/src/Siv3D/FrameRateLimit/SivFrameRateLimit.cpp
+  ../Siv3D/src/Siv3D/FrameRateLimit/FrameRateLimitFactory.cpp
   ../Siv3D/src/Siv3D/Gamepad/GamepadFactory.cpp
   ../Siv3D/src/Siv3D/Gamepad/SivGamepad.cpp
   ../Siv3D/src/Siv3D/GamepadInfo/SivGamepadInfo.cpp

Siv3D/include/Siv3D/Graphics.hpp

@@ -11,6 +11,7 @@
 
 # pragma once
 # include "Common.hpp"
+# include "Optional.hpp"
 
 namespace s3d
 {
@@ -27,5 +28,15 @@ namespace s3d
 		/// @return VSync が有効である場合 true, 無効である場合 false
 		[[nodiscard]]
 		bool IsVSyncEnabled();
+
+		/// @brief VSync 無効時の目標フレームレートを設定します。
+		/// @param fps 目標フレームレート（FPS）。フレームレート制限を無効にする場合は none
+		/// @remark デフォルトでは none です。
+		void SetTargetFrameRate(const Optional<double>& fps);
+
+		/// @brief VSync 無効時の目標フレームレートを取得します。
+		/// @return 目標フレームレート（FPS）。フレームレート制限が無効の場合は none
+		[[nodiscard]]
+		Optional<double> GetTargetFrameRate();
 	}
 }

Siv3D/src/Siv3D-Platform/Linux/Siv3D/System/CSystem.cpp

@@ -51,6 +51,7 @@
 # include <Siv3D/Effect/IEffect.hpp>
 # include <Siv3D/Script/IScript.hpp>
 # include <Siv3D/Addon/IAddon.hpp>
+# include <Siv3D/FrameRateLimit/IFrameRateLimit.hpp>
 # include <Siv3D/System/SystemLog.hpp>
 # include <Siv3D/System/SystemMisc.hpp>
 # include "CSystem.hpp"
@@ -131,6 +132,7 @@ namespace s3d
 		SIV3D_ENGINE(Renderer)->present();
 		SIV3D_ENGINE(ScreenCapture)->update();
 		SIV3D_ENGINE(Addon)->postPresent();
+		SIV3D_ENGINE(FrameRateLimit)->update();
 
 		//
 		// previous frame

Siv3D/src/Siv3D-Platform/Web/Siv3D/System/CSystem.cpp

@@ -50,6 +50,7 @@
 # include <Siv3D/Asset/IAsset.hpp>
 # include <Siv3D/Effect/IEffect.hpp>
 # include <Siv3D/Addon/IAddon.hpp>
+# include <Siv3D/FrameRateLimit/IFrameRateLimit.hpp>
 # include <Siv3D/Script/IScript.hpp>
 # include <Siv3D/System/SystemLog.hpp>
 # include <Siv3D/System/SystemMisc.hpp>
@@ -151,6 +152,7 @@ namespace s3d
 		SIV3D_ENGINE(Renderer)->present();
 		SIV3D_ENGINE(ScreenCapture)->update();
 		SIV3D_ENGINE(Addon)->postPresent();
+		SIV3D_ENGINE(FrameRateLimit)->update();
 
 		detail::siv3dRequestAnimationFrame();
 

Siv3D/src/Siv3D-Platform/WindowsDesktop/Siv3D/Renderer/D3D11/SwapChain/D3D11SwapChain.cpp

@@ -138,9 +138,6 @@ namespace s3d
 			m_previousWindowBounds = windowBounds;
 		}
 
-		//const bool vSync = (not m_targetFrameRateHz.has_value())
-		//	|| ((30.0 <= m_targetFrameRateHz) && (AbsDiff(m_targetFrameRateHz.value(), m_displayFrequency) <= 3.0));
-
 		return vSync ? presentVSync() : presentNonVSync();
 	}
 
@@ -149,16 +146,6 @@ namespace s3d
 		return m_displayFrequency;
 	}
 
-	//void D3D11SwapChain::setTargetFrameRateHz(const Optional<double>& targetFrameRateHz)
-	//{
-	//	m_targetFrameRateHz = targetFrameRateHz;
-	//}
-
-	//const Optional<double>& D3D11SwapChain::getTargetFrameRateHz() const noexcept
-	//{
-	//	return m_targetFrameRateHz;
-	//}
-
 	IDXGISwapChain1* D3D11SwapChain::getSwapChain1() const noexcept
 	{
 		return m_swapChain1.Get();
@@ -245,37 +232,6 @@ namespace s3d
 
 	bool D3D11SwapChain::presentNonVSync()
 	{
-		/*
-		const double targetRefreshRateHz = m_targetFrameRateHz.value();
-		const double targetRefreshPeriodMillisec = (1000.0 / targetRefreshRateHz);
-		const double displayRefreshPeriodMillisec = detail::GetDisplayRefreshPeriodMillisec();
-
-		LARGE_INTEGER counter;
-		::QueryPerformanceCounter(&counter);
-
-		{
-			m_context->Flush();
-
-			double timeToSleepMillisec = 0.0;
-			::timeBeginPeriod(1);
-
-			do
-			{
-				::QueryPerformanceCounter(&counter);
-				const double timeSinceFlipMillisec = detail::ToMillisec(counter.QuadPart - m_lastPresentTime);
-
-				timeToSleepMillisec = (targetRefreshPeriodMillisec - timeSinceFlipMillisec);
-
-				if (timeToSleepMillisec > 0.0)
-				{
-					::Sleep(static_cast<int32>(timeToSleepMillisec));
-				}
-			} while (timeToSleepMillisec > 0.5);
-
-			::timeEndPeriod(1);
-		}
-		*/
-
 		const UINT presentFlags = m_tearingSupport ? DXGI_PRESENT_ALLOW_TEARING : 0;
 		const HRESULT hr = m_swapChain1->Present(0, presentFlags);
 
@@ -294,8 +250,6 @@ namespace s3d
 			return false;
 		}
 
-		//m_lastPresentTime = counter.QuadPart;
-
 		return true;
 	}
 }

Siv3D/src/Siv3D-Platform/WindowsDesktop/Siv3D/Renderer/D3D11/SwapChain/D3D11SwapChain.hpp

@@ -59,11 +59,6 @@ namespace s3d
 		[[nodiscard]]
 		double getDisplayFrequency() const noexcept;
 
-		//void setTargetFrameRateHz(const Optional<double>& targetFrameRateHz);
-
-		//[[nodiscard]]
-		//const Optional<double>& getTargetFrameRateHz() const noexcept;
-
 		[[nodiscard]]
 		IDXGISwapChain1* getSwapChain1() const noexcept;
 

Siv3D/src/Siv3D-Platform/WindowsDesktop/Siv3D/System/CSystem.cpp

@@ -52,6 +52,7 @@
 # include <Siv3D/Asset/IAsset.hpp>
 # include <Siv3D/Effect/IEffect.hpp>
 # include <Siv3D/Addon/IAddon.hpp>
+# include <Siv3D/FrameRateLimit/IFrameRateLimit.hpp>
 # include <Siv3D/System/SystemLog.hpp>
 # include <Siv3D/System/SystemMisc.hpp>
 # include <Siv3D/Windows/Windows.hpp>
@@ -177,6 +178,7 @@ namespace s3d
 		SIV3D_ENGINE(Renderer)->present();
 		SIV3D_ENGINE(ScreenCapture)->update();
 		SIV3D_ENGINE(Addon)->postPresent();
+		SIV3D_ENGINE(FrameRateLimit)->update();
 
 		//
 		// previous frame

Siv3D/src/Siv3D-Platform/macOS/Siv3D/System/CSystem.cpp

@@ -51,6 +51,7 @@
 # include <Siv3D/Effect/IEffect.hpp>
 # include <Siv3D/Script/IScript.hpp>
 # include <Siv3D/Addon/IAddon.hpp>
+# include <Siv3D/FrameRateLimit/IFrameRateLimit.hpp>
 # include <Siv3D/System/SystemLog.hpp>
 # include <Siv3D/System/SystemMisc.hpp>
 # include "CSystem.hpp"
@@ -131,6 +132,7 @@ namespace s3d
 		SIV3D_ENGINE(Renderer)->present();
 		SIV3D_ENGINE(ScreenCapture)->update();
 		SIV3D_ENGINE(Addon)->postPresent();
+		SIV3D_ENGINE(FrameRateLimit)->update();
 
 		//
 		// previous frame

Siv3D/src/Siv3D/Common/Siv3DEngine.cpp

@@ -58,6 +58,7 @@
 # include <Siv3D/TrailRenderer/ITrailRenderer.hpp>
 # include <Siv3D/Script/IScript.hpp>
 # include <Siv3D/Addon/IAddon.hpp>
+# include <Siv3D/FrameRateLimit/IFrameRateLimit.hpp>
 
 namespace s3d
 {

Siv3D/src/Siv3D/Common/Siv3DEngine.hpp

@@ -63,6 +63,7 @@ namespace s3d
 	class ISiv3DTrailRenderer;
 	class ISiv3DScript;
 	class ISiv3DAddon;
+	class ISiv3DFrameRateLimit;
 
 	class Siv3DEngine
 	{
@@ -118,7 +119,8 @@ namespace s3d
 			Siv3DComponent<ISiv3DEffect>,
 			Siv3DComponent<ISiv3DTrailRenderer>,
 			Siv3DComponent<ISiv3DScript>,
-			Siv3DComponent<ISiv3DAddon>> m_components;
+			Siv3DComponent<ISiv3DAddon>,
+			Siv3DComponent<ISiv3DFrameRateLimit>> m_components;
 
 	public:
 

Siv3D/src/Siv3D/FrameRateLimit/CFrameRateLimit.hpp

@@ -0,0 +1,86 @@
+//-----------------------------------------------
+//
+//	This file is part of the Siv3D Engine.
+//
+//	Copyright (c) 2008-2023 Ryo Suzuki
+//	Copyright (c) 2016-2023 OpenSiv3D Project
+//
+//	Licensed under the MIT License.
+//
+//-----------------------------------------------
+
+# pragma once
+# include "IFrameRateLimit.hpp"
+
+namespace s3d
+{
+	class CFrameRateLimit final : public ISiv3DFrameRateLimit
+	{
+	public:
+
+		using clock_type = std::chrono::steady_clock;
+
+		/// @brief フレームレート制限を実行します。
+		void update() override;
+
+		/// @brief 目標フレームレートを設定します。
+		/// @param fps 目標フレームレート（FPS）。フレームレート制限を無効にする場合は none
+		void setTargetFrameRate(const Optional<double>& fps) override;
+
+		/// @brief 目標フレームレートを取得します。
+		/// @return 目標フレームレート（FPS）。フレームレート制限が無効の場合は none
+		SIV3D_NODISCARD_CXX20
+		Optional<double> getTargetFrameRate() const override;
+
+	private:
+
+		class Limiter
+		{
+		public:
+
+			/// @brief コンストラクタ
+			/// @param fps 目標フレームレート（FPS）
+			/// @throw Error fps が無効な値の場合
+			SIV3D_NODISCARD_CXX20
+			explicit Limiter(double fps);
+
+			/// @brief sleepを実行し、フレームを次に進めます。
+			void doSleep();
+
+			/// @brief 目標フレームレートを設定します。
+			/// @param targetFrameRate 目標フレームレート（FPS）
+			/// @throw Error fps が無効な値の場合
+			void setTargetFrameRate(double fps);
+
+			/// @brief 目標フレームレートを取得します。
+			/// @return 目標フレームレート（FPS）
+			SIV3D_NODISCARD_CXX20
+			double getTargetFrameRate() const noexcept { return m_fps; }
+
+		private:
+
+			/// @brief 1秒間
+			static constexpr clock_type::duration OneSecond = std::chrono::seconds{ 1 };
+
+			/// @brief 目標フレームレート（FPS）
+			double m_fps;
+
+			/// @brief 1フレームあたりの時間
+			clock_type::duration m_oneFrameDuration;
+
+			/// @brief 目標sleep時刻
+			clock_type::time_point m_sleepUntil;
+
+			/// @brief フレームレートから1フレームあたりの時間の長さを計算します。
+			/// @param fps フレームレート（FPS）
+			/// @return 1フレームあたりの時間の長さ
+			/// @throw Error fps が無効な値の場合
+			SIV3D_NODISCARD_CXX20
+			static clock_type::duration FPSToOneFrameDuration(double fps);
+		};
+
+		/// @brief フレームレート制限
+		/// @remark フレームレート制限が無効の場合は nullptr
+		std::unique_ptr<Limiter> m_limiter;
+	};
+}

Siv3D/src/Siv3D/FrameRateLimit/FrameRateLimitFactory.cpp

@@ -0,0 +1,20 @@
+//-----------------------------------------------
+//
+//	This file is part of the Siv3D Engine.
+//
+//	Copyright (c) 2008-2023 Ryo Suzuki
+//	Copyright (c) 2016-2023 OpenSiv3D Project
+//
+//	Licensed under the MIT License.
+//
+//-----------------------------------------------
+
+# include "CFrameRateLimit.hpp"
+
+namespace s3d
+{
+	ISiv3DFrameRateLimit* ISiv3DFrameRateLimit::Create()
+	{
+		return new CFrameRateLimit;
+	}
+}

Siv3D/src/Siv3D/FrameRateLimit/IFrameRateLimit.hpp

@@ -0,0 +1,32 @@
+//-----------------------------------------------
+//
+//	This file is part of the Siv3D Engine.
+//
+//	Copyright (c) 2008-2023 Ryo Suzuki
+//	Copyright (c) 2016-2023 OpenSiv3D Project
+//
+//	Licensed under the MIT License.
+//
+//-----------------------------------------------
+
+# pragma once
+# include <Siv3D/Common.hpp>
+# include <Siv3D/Optional.hpp>
+
+namespace s3d
+{
+	class SIV3D_NOVTABLE ISiv3DFrameRateLimit
+	{
+	public:
+
+		static ISiv3DFrameRateLimit* Create();
+
+		virtual ~ISiv3DFrameRateLimit() = default;
+
+		virtual void update() = 0;
+
+		virtual void setTargetFrameRate(const Optional<double>& fps) = 0;
+
+		virtual Optional<double> getTargetFrameRate() const = 0;
+	};
+}