Arma Reforger Script API
Loading...
Searching...
No Matches
Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_FPSDiagnosticPlugin Interface Reference
Inheritance diagram for SCR_FPSDiagnosticPlugin:

Protected Member Functions

override void Run ()
 
bool WaitFocused (float secondsToWait)
 
void PlaceCamera (notnull WorldEditorAPI worldEditorAPI, CameraBase camera, vector position, vector direction)
 
bool CreateImage (string imagePath, int definition, notnull array< float > fpsArray)
 
int ButtonDiagnose ()
 
int ButtonClose ()
 

Protected Attributes

vector m_vPositionOffset
 
bool m_bAnalyseOnOcean
 
bool m_bRandomisePositions
 
ref array< vector > m_aOrientations
 
float m_fStartDelay
 
float m_fScenePause
 
int m_iHeatmapColourMode
 
bool m_bHeatmapValueInversion
 
int m_iHeatmapMaxValueMode
 
bool m_bHeatmapHighlightValuesAboveMax
 
int m_iHeatmapDefinition
 
int m_iHeatmapResolutionFactor
 
bool m_bUseGameMode
 
bool m_bUseFullScreen
 
int m_iOpenHeatmap
 
int m_iTimeEstimateFrequency
 
bool m_bUseFakeData
 
bool m_bInternalUseGameMode
 
int m_iLastEstimateTick
 

Static Protected Attributes

static const float CAMERA_DEFAULT_ALTITUDE = 7.5
 
static const float CAMERA_DEFAULT_PITCH = -10
 
static const int CAMERA_DEFAULT_ANGLE_COUNT = 4
 
static const int DEFINITION_DEFAULT = 64
 
static const float FPS_UNFOCUSED = 3.0
 if FPS are equal to this value, the capture ends
 
static const float FPS_UNFOCUSED_DELTA = 0.01
 delta used in float.AlmostEqual
 
static const float FPS_UNFOCUSED_DURATION_MS = 0
 how much time must FPS stay at FPS_UNFOCUSED to trigger cancellation
 
static const int MAX_FPS = 500
 if FPS are above this threshold, FPS is reobtained (Workbench bug)
 
static const float FPS_HIGH_DURATION_MS = 2000
 if FPS are above the threshold for more than this delay (s), cancel
 
static const int FPS_CHECK_FREQUENCY_MS = 100
 waiting time between FPS measurements when the threshold is crossed
 
static const int FPS_RANDOM_MIN = 0
 
static const int FPS_RANDOM_MID = 45
 
static const int FPS_RANDOM_MAX = 60
 
static const float ESTIMATE_FACTOR = 1.10
 by how much the theoretical duration must be multiplied
 
static const string OUTPUT_HEATMAP_NAME = "Heatmap_FPS_%1_%2_%3x%3.dds"
 %1 = world name, %2 = colour mode (BW, RGB), %3 = image's definition
 

Member Function Documentation

◆ ButtonClose()

int SCR_FPSDiagnosticPlugin.ButtonClose ( )
protected

◆ ButtonDiagnose()

int SCR_FPSDiagnosticPlugin.ButtonDiagnose ( )
protected

◆ CreateImage()

bool SCR_FPSDiagnosticPlugin.CreateImage ( string imagePath,
int definition,
notnull array< float > fpsArray )
protected
Parameters
[in]imagePath
[in]definition
[in]fpsArray
Returns
true on success, false otherwise

◆ PlaceCamera()

void SCR_FPSDiagnosticPlugin.PlaceCamera ( notnull WorldEditorAPI worldEditorAPI,
CameraBase camera,
vector position,
vector direction )
protected

◆ Run()

override void SCR_FPSDiagnosticPlugin.Run ( )
protected

◆ WaitFocused()

bool SCR_FPSDiagnosticPlugin.WaitFocused ( float secondsToWait)
protected
Parameters
[in]secondsToWait
Returns
true on successful wait, false on unfocus

Member Data Documentation

◆ CAMERA_DEFAULT_ALTITUDE

const float SCR_FPSDiagnosticPlugin.CAMERA_DEFAULT_ALTITUDE = 7.5
staticprotected

◆ CAMERA_DEFAULT_ANGLE_COUNT

const int SCR_FPSDiagnosticPlugin.CAMERA_DEFAULT_ANGLE_COUNT = 4
staticprotected

◆ CAMERA_DEFAULT_PITCH

const float SCR_FPSDiagnosticPlugin.CAMERA_DEFAULT_PITCH = -10
staticprotected

◆ DEFINITION_DEFAULT

const int SCR_FPSDiagnosticPlugin.DEFINITION_DEFAULT = 64
staticprotected

◆ ESTIMATE_FACTOR

const float SCR_FPSDiagnosticPlugin.ESTIMATE_FACTOR = 1.10
staticprotected

by how much the theoretical duration must be multiplied

◆ FPS_CHECK_FREQUENCY_MS

const int SCR_FPSDiagnosticPlugin.FPS_CHECK_FREQUENCY_MS = 100
staticprotected

waiting time between FPS measurements when the threshold is crossed

◆ FPS_HIGH_DURATION_MS

const float SCR_FPSDiagnosticPlugin.FPS_HIGH_DURATION_MS = 2000
staticprotected

if FPS are above the threshold for more than this delay (s), cancel

◆ FPS_RANDOM_MAX

const int SCR_FPSDiagnosticPlugin.FPS_RANDOM_MAX = 60
staticprotected

◆ FPS_RANDOM_MID

const int SCR_FPSDiagnosticPlugin.FPS_RANDOM_MID = 45
staticprotected

◆ FPS_RANDOM_MIN

const int SCR_FPSDiagnosticPlugin.FPS_RANDOM_MIN = 0
staticprotected

◆ FPS_UNFOCUSED

const float SCR_FPSDiagnosticPlugin.FPS_UNFOCUSED = 3.0
staticprotected

if FPS are equal to this value, the capture ends

◆ FPS_UNFOCUSED_DELTA

const float SCR_FPSDiagnosticPlugin.FPS_UNFOCUSED_DELTA = 0.01
staticprotected

delta used in float.AlmostEqual

◆ FPS_UNFOCUSED_DURATION_MS

const float SCR_FPSDiagnosticPlugin.FPS_UNFOCUSED_DURATION_MS = 0
staticprotected

how much time must FPS stay at FPS_UNFOCUSED to trigger cancellation

◆ m_aOrientations

ref array<vector> SCR_FPSDiagnosticPlugin.m_aOrientations
protected

◆ m_bAnalyseOnOcean

bool SCR_FPSDiagnosticPlugin.m_bAnalyseOnOcean
protected

◆ m_bHeatmapHighlightValuesAboveMax

bool SCR_FPSDiagnosticPlugin.m_bHeatmapHighlightValuesAboveMax
protected

◆ m_bHeatmapValueInversion

bool SCR_FPSDiagnosticPlugin.m_bHeatmapValueInversion
protected

◆ m_bInternalUseGameMode

bool SCR_FPSDiagnosticPlugin.m_bInternalUseGameMode
protected

◆ m_bRandomisePositions

bool SCR_FPSDiagnosticPlugin.m_bRandomisePositions
protected

◆ m_bUseFakeData

bool SCR_FPSDiagnosticPlugin.m_bUseFakeData
protected

◆ m_bUseFullScreen

bool SCR_FPSDiagnosticPlugin.m_bUseFullScreen
protected

◆ m_bUseGameMode

bool SCR_FPSDiagnosticPlugin.m_bUseGameMode
protected

◆ m_fScenePause

float SCR_FPSDiagnosticPlugin.m_fScenePause
protected

◆ m_fStartDelay

float SCR_FPSDiagnosticPlugin.m_fStartDelay
protected

◆ m_iHeatmapColourMode

int SCR_FPSDiagnosticPlugin.m_iHeatmapColourMode
protected

◆ m_iHeatmapDefinition

int SCR_FPSDiagnosticPlugin.m_iHeatmapDefinition
protected

◆ m_iHeatmapMaxValueMode

int SCR_FPSDiagnosticPlugin.m_iHeatmapMaxValueMode
protected

◆ m_iHeatmapResolutionFactor

int SCR_FPSDiagnosticPlugin.m_iHeatmapResolutionFactor
protected

◆ m_iLastEstimateTick

int SCR_FPSDiagnosticPlugin.m_iLastEstimateTick
protected

◆ m_iOpenHeatmap

int SCR_FPSDiagnosticPlugin.m_iOpenHeatmap
protected

◆ m_iTimeEstimateFrequency

int SCR_FPSDiagnosticPlugin.m_iTimeEstimateFrequency
protected

◆ m_vPositionOffset

vector SCR_FPSDiagnosticPlugin.m_vPositionOffset
protected

◆ MAX_FPS

const int SCR_FPSDiagnosticPlugin.MAX_FPS = 500
staticprotected

if FPS are above this threshold, FPS is reobtained (Workbench bug)

◆ OUTPUT_HEATMAP_NAME

const string SCR_FPSDiagnosticPlugin.OUTPUT_HEATMAP_NAME = "Heatmap_FPS_%1_%2_%3x%3.dds"
staticprotected

%1 = world name, %2 = colour mode (BW, RGB), %3 = image's definition

The documentation for this interface was generated from the following file:
Generated by doxygen 1.13.2