GetCurrentFPS - Revision history

Lettify: Fixed a small madness in which the FPS changes with eachFixed a small craziness in which the FPS variable changes every frame and not every second

2020-12-30T01:17:57Z

Fixed a small madness in which the FPS changes with eachFixed a small craziness in which the FPS variable changes every frame and not every second

← Older revision		Revision as of 01:17, 30 December 2020
Line 12:		Line 12:
	==Code==		==Code==
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">local fps = 0		<syntaxhighlight lang="lua">
			local fps = 0
			local nextTick = 0
	function getCurrentFPS() -- Setup the useful function		function getCurrentFPS() -- Setup the useful function
	return fps		return fps
Line 19:		Line 21:
	local function updateFPS(msSinceLastFrame)		local function updateFPS(msSinceLastFrame)
	-- FPS are the frames per second, so count the frames rendered per milisecond using frame delta time and then convert that to frames per second.		-- FPS are the frames per second, so count the frames rendered per milisecond using frame delta time and then convert that to frames per second.
	fps = (1 / msSinceLastFrame) * 1000		local now = getTickCount()
			if (now >= nextTick) then
			fps = (1 / msSinceLastFrame) * 1000
			nextTick = now + 1000
			end
	end		end
	addEventHandler("onClientPreRender", root, updateFPS)</syntaxhighlight>		addEventHandler("onClientPreRender", root, updateFPS)
			</syntaxhighlight>
	</section>		</section>

Motar2k: /* Code */

2020-04-21T19:28:12Z

Code

← Older revision		Revision as of 19:28, 21 April 2020
Line 12:		Line 12:
	==Code==		==Code==
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">local fps = ~~false~~		<syntaxhighlight lang="lua">local fps = 0
	function getCurrentFPS() -- Setup the useful function		function getCurrentFPS() -- Setup the useful function
	return fps		return fps

AlexTMjugador: /* Examples */

2016-06-16T10:07:22Z

Examples

← Older revision		Revision as of 10:07, 16 June 2016
Line 43:		Line 43:
	-- Average FPS = (FPS1 + FPS2 + ... + FPSX) / X		-- Average FPS = (FPS1 + FPS2 + ... + FPSX) / X
	local totalFPS = 0		local totalFPS = 0
	for _, fps in ~~ipairs~~(table) do		for _, fps in pairs(table) do
	totalFPS = totalFPS + fps		totalFPS = totalFPS + fps
	end		end
Line 59:		Line 59:
	-- Insert current FPS into a table for reference		-- Insert current FPS into a table for reference
	table.insert(currentSecondFPS, getCurrentFPS())		table.insert(currentSecondFPS, getCurrentFPS())
	-- If a second passed, get the average FPS using the table (we always have at least one frame rendered, so dividing by 0 it's not a problem)		-- If a second passed, get the average FPS using the table
	~~local averageFPSPerSecond~~		-- (We always have at least one frame rendered, so dividing by 0 it's not a problem)
	if getTickCount() - lastSecondTicks >= 1000 then		if getTickCount() - lastSecondTicks >= 1000 then
	averageFPSPerSecond = getAverageFPSOfFPSArray(currentSecondFPS)		local averageFPSPerSecond = getAverageFPSOfFPSArray(currentSecondFPS)
	-- Reset variables		-- Reset variables
	currentSecondFPS = {}		currentSecondFPS = {}
	lastSecondTicks = getTickCount()		lastSecondTicks = getTickCount()
	~~end~~		-- Update the table containing last five seconds FPS
	-- ~~If a second has passed, update~~ the table containing last five seconds FPS.		-- Also update the FPS limit accordingly
	-- Also update the FPS limit accordingly.
	~~if averageFPSPerSecond then~~
	table.insert(lastFiveSecondsFPS, averageFPSPerSecond)		table.insert(lastFiveSecondsFPS, averageFPSPerSecond)
	-- Silently discard too old average FPS		-- Silently discard too old average FPS
Line 75:		Line 73:
	table.remove(lastFiveSecondsFPS, 1)		table.remove(lastFiveSecondsFPS, 1)
	end		end
	-- Get the average FPS of the average FPS of each of the last five seconds, and use the result as the frame limit.		-- Get the average FPS of the average FPS of each of the last five seconds, and use the result as the frame limit
	setFPSLimit(math.ceil(getAverageFPSOfFPSArray(lastFiveSecondsFPS)))		setFPSLimit(math.ceil(getAverageFPSOfFPSArray(lastFiveSecondsFPS)))
	end		end

AlexTMjugador: /* Examples */

2014-11-11T18:36:39Z

Examples

← Older revision		Revision as of 18:36, 11 November 2014
Line 38:		Line 38:
	addEventHandler("onClientHUDRender", root, drawFPS)</syntaxhighlight>		addEventHandler("onClientHUDRender", root, drawFPS)</syntaxhighlight>

	The next script mitigates ~~lag spikes~~ by setting the ''FPS'' limit to the average ''FPS'' of the last 5 seconds.		The next script mitigates ''FPS'' variations by setting the ''FPS'' limit to the average ''FPS'' of the last 5 seconds.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local function getAverageFPSOfFPSArray(table)		local function getAverageFPSOfFPSArray(table)

AlexTMjugador: Error fixes at /* Examples */

2014-11-11T18:31:09Z

Error fixes at Examples

← Older revision		Revision as of 18:31, 11 November 2014
Line 30:		Line 30:
	<syntaxhighlight lang="lua">local sx = guiGetScreenSize()		<syntaxhighlight lang="lua">local sx = guiGetScreenSize()
	local function drawFPS()		local function drawFPS()
			if not getCurrentFPS() then
			return
			end
	local roundedFPS = math.floor(getCurrentFPS())		local roundedFPS = math.floor(getCurrentFPS())
	dxDrawText(roundedFPS, sx - dxGetTextWidth(roundedFPS), 0)		dxDrawText(roundedFPS, sx - dxGetTextWidth(roundedFPS), 0)
Line 50:		Line 53:
	local lastFiveSecondsFPS = {}		local lastFiveSecondsFPS = {}
	local function smoothFPS()		local function smoothFPS()
			-- Do we have a FPS rate already?
			if not getCurrentFPS() then
			return
			end
	-- Insert current FPS into a table for reference		-- Insert current FPS into a table for reference
	table.insert(currentSecondFPS, getCurrentFPS())		table.insert(currentSecondFPS, getCurrentFPS())

AlexTMjugador: /* Examples */

2014-11-11T15:47:52Z

Examples

← Older revision		Revision as of 15:47, 11 November 2014
Line 69:		Line 69:
	end		end
	-- Get the average FPS of the average FPS of each of the last five seconds, and use the result as the frame limit.		-- Get the average FPS of the average FPS of each of the last five seconds, and use the result as the frame limit.
	setFPSLimit(math.ceil(getAverageFPSOfFPSArray(lastFiveSecondsFPS))		setFPSLimit(math.ceil(getAverageFPSOfFPSArray(lastFiveSecondsFPS)))
	end		end
	end		end

AlexTMjugador: AlexTMjugador moved page GetFPS to GetCurrentFPS: More proper function name

2014-11-11T14:55:06Z

AlexTMjugador moved page GetFPS to GetCurrentFPS: More proper function name

← Older revision

Revision as of 14:55, 11 November 2014

AlexTMjugador at 14:54, 11 November 2014

2014-11-11T14:54:16Z

← Older revision		Revision as of 14:54, 11 November 2014
Line 23:		Line 23:
	addEventHandler("onClientPreRender", root, updateFPS)</syntaxhighlight>		addEventHandler("onClientPreRender", root, updateFPS)</syntaxhighlight>
	</section>		</section>

			* Original author: ''StiviK''.

	==Examples==		==Examples==
Line 72:		Line 74:
	addEventHandler("onClientHUDRender", root, smoothFPS)		addEventHandler("onClientHUDRender", root, smoothFPS)
	</syntaxhighlight>		</syntaxhighlight>

	* Original author: ''StiviK''.

	==See also==		==See also==
	{{Useful_Functions}}		{{Useful_Functions}}

AlexTMjugador: /* Examples */

2014-11-11T14:52:23Z

Examples

← Older revision		Revision as of 14:52, 11 November 2014
Line 28:		Line 28:
	<syntaxhighlight lang="lua">local sx = guiGetScreenSize()		<syntaxhighlight lang="lua">local sx = guiGetScreenSize()
	local function drawFPS()		local function drawFPS()
	~~dxDrawText(~~math.floor(getCurrentFPS()), sx - dxGetTextWidth(~~math.floor(getCurrentFPS())~~), 0)		local roundedFPS = math.floor(getCurrentFPS())
			dxDrawText(roundedFPS, sx - dxGetTextWidth(roundedFPS), 0)
	end		end
	addEventHandler("onClientHUDRender", root, drawFPS)</syntaxhighlight>		addEventHandler("onClientHUDRender", root, drawFPS)</syntaxhighlight>

AlexTMjugador: Made function faster and more accurate. Also added an example.

2014-11-11T14:25:05Z

Made function faster and more accurate. Also added an example.

← Older revision		Revision as of 14:25, 11 November 2014
Line 2:		Line 2:
	<lowercasetitle/>		<lowercasetitle/>
	__NOTOC__		__NOTOC__
	This function ~~counts~~ the FPS ~~and getFPS~~() ~~returns the FPS Count~~.		This clientside useful function returns the current ''FPS'' (frames per second) at which GTA: SA is running.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">~~int getFPS~~( )</syntaxhighlight>		<syntaxhighlight lang="lua">float/boolean getCurrentFPS( )</syntaxhighlight>

	==~~=Required Arguments=~~==		==Returns==
	* none		This function returns a ''number'' telling the current ''FPS'' if they could be calculated. Returns ''false'' otherwise.

	==Code==		==Code==
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">local fps = false
	~~fps = {~~fps = ~~0, realFPS = 0, lastTick = getTickCount()}~~		function getCurrentFPS() -- Setup the useful function
	~~addEventHandler("onClientRender", root,~~ function ()		return fps
	~~if (getTickCount()~~ - ~~fps.lastTick) >= 1000 then~~		end
	~~fps.lastTick = getTickCount()~~
	~~fps.realFPS = fps.fps~~
	~~fps.fps = 0~~
	~~end~~

	fps~~.fps = fps.fps + 1~~
	end)

	function ~~getFPS~~ ()		local function updateFPS(msSinceLastFrame)
	~~return~~ fps~~.realFPS;~~		-- FPS are the frames per second, so count the frames rendered per milisecond using frame delta time and then convert that to frames per second.
			fps = (1 / msSinceLastFrame) * 1000
	end		end
	</syntaxhighlight>		addEventHandler("onClientPreRender", root, updateFPS)</syntaxhighlight>
	</section>		</section>

	==~~Example~~==		==Examples==
	<~~section name~~="~~Client~~" ~~class~~="~~client" show="true~~">		The next example draws the current ''FPS'' rounded to an integer in the up-right corner of the screen.
			<syntaxhighlight lang="lua">local sx = guiGetScreenSize()
			local function drawFPS()
			dxDrawText(math.floor(getCurrentFPS()), sx - dxGetTextWidth(math.floor(getCurrentFPS())), 0)
			end
			addEventHandler("onClientHUDRender", root, drawFPS)</syntaxhighlight>

			The next script mitigates lag spikes by setting the ''FPS'' limit to the average ''FPS'' of the last 5 seconds.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addCommandHandler~~(~~"outputFPS"~~, function ()		local function getAverageFPSOfFPSArray(table)
	~~outputChatBox~~(~~"Your~~ FPS ~~are: "~~..~~getFPS~~())		-- Average FPS = (FPS1 + FPS2 + ... + FPSX) / X
	end)		local totalFPS = 0
			for _, fps in ipairs(table) do
			totalFPS = totalFPS + fps
			end
			return totalFPS / #table
			end

			local currentSecondFPS = {}
			local lastSecondTicks = getTickCount()
			local lastFiveSecondsFPS = {}
			local function smoothFPS()
			-- Insert current FPS into a table for reference
			table.insert(currentSecondFPS, getCurrentFPS())
			-- If a second passed, get the average FPS using the table (we always have at least one frame rendered, so dividing by 0 it's not a problem)
			local averageFPSPerSecond
			if getTickCount() - lastSecondTicks >= 1000 then
			averageFPSPerSecond = getAverageFPSOfFPSArray(currentSecondFPS)
			-- Reset variables
			currentSecondFPS = {}
			lastSecondTicks = getTickCount()
			end
			-- If a second has passed, update the table containing last five seconds FPS.
			-- Also update the FPS limit accordingly.
			if averageFPSPerSecond then
			table.insert(lastFiveSecondsFPS, averageFPSPerSecond)
			-- Silently discard too old average FPS
			if #lastFiveSecondsFPS == 6 then
			table.remove(lastFiveSecondsFPS, 1)
			end
			-- Get the average FPS of the average FPS of each of the last five seconds, and use the result as the frame limit.
			setFPSLimit(math.ceil(getAverageFPSOfFPSArray(lastFiveSecondsFPS))
			end
			end
			addEventHandler("onClientHUDRender", root, smoothFPS)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	~~Author~~: StiviK		* Original author: ''StiviK''.

	==See ~~Also~~==		==See also==
	{{Useful_Functions}}		{{Useful_Functions}}