BIS fnc fps: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= Diagnostic |GROUP1=
|gr1= Diagnostic


|eff= local|= Effect in MP
|eff= local|= Effect in MP


| Function to measure FPS. Spawns code running for given time and displays result on screen ''via'' [[titleText]], [[globalChat]] '''and''' [[diag_log]]. Variable '''BIS_fps_output''' is filled with diag_log content too. |DESCRIPTION=
| Function to measure FPS. Spawns code running for given time and displays result on screen ''via'' [[titleText]], [[globalChat]] '''and''' [[diag_log]]. Variable '''BIS_fps_output''' is filled with diag_log content too.


| [duration, sceneId, startDelay] call [[BIS_fnc_fps]] |SYNTAX=
| [duration, sceneId, startDelay] call [[BIS_fnc_fps]]


|p1= duration: [[Number]] - the FPS test duration |PARAMETER1=
|p1= duration: [[Number]] - the FPS test duration


|p2= sceneId: [[String]] - (Optional, default "") scene ID, used in outputs. Fills global variable '''currentScene''' |PARAMETER2=
|p2= sceneId: [[String]] - (Optional, default "") scene ID, used in outputs. Fills global variable '''currentScene'''


|p3= startDelay: [[Number]] - (Optional, default 0) delay before starting measurement |PARAMETER3=
|p3= startDelay: [[Number]] - (Optional, default 0) delay before starting measurement


| [[Script_(Handle)|Script handle]] |RETURNVALUE=
| [[Script_(Handle)|Script handle]]


|x1= <code>_scriptHandle = [10, "50 units on screen", 3] [[call]] [[BIS_fnc_fps]];</code> |EXAMPLE1=
|x1= <code>_scriptHandle = [10, "50 units on screen", 3] [[call]] [[BIS_fnc_fps]];</code>


| [[diag_fps]], [[diag_fpsMin]], [[diag_frameNo]], [[diag_tickTime]] |SEEALSO=
| [[diag_fps]], [[diag_fpsMin]], [[diag_frameNo]], [[diag_tickTime]]
}}
}}



Revision as of 23:04, 17 January 2021

Hover & click on the images for description

Description

Description:
Function to measure FPS. Spawns code running for given time and displays result on screen via titleText, globalChat and diag_log. Variable BIS_fps_output is filled with diag_log content too.
Execution:
call
Groups:
Diagnostic

Syntax

Syntax:
[duration, sceneId, startDelay] call BIS_fnc_fps
Parameters:
duration: Number - the FPS test duration
sceneId: String - (Optional, default "") scene ID, used in outputs. Fills global variable currentScene
startDelay: Number - (Optional, default 0) delay before starting measurement
Return Value:
Script handle

Examples

Example 1:
_scriptHandle = [10, "50 units on screen", 3] call BIS_fnc_fps;

Additional Information

See also:
diag_fpsdiag_fpsMindiag_frameNodiag_tickTime

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note


Bottom Section