getVideoOptions: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add headless systems note)
m (Fix phrasing)
Line 12: Line 12:
|s1= [[getVideoOptions]]
|s1= [[getVideoOptions]]


|r1= [[HashMap]] - all video settings, the key is always a [[String]], the value can be a [[String]], [[Number]], [[Boolean]] or [[Array]] (see {{Link|#Example 1}})
|r1= [[HashMap]] - all video settings, the key is always a [[String]], the value can be a [[String]], [[Number]], [[Boolean]] or [[Array]] (see {{Link|#Example 1}}).
{{Feature|important|{{hl|vramInfo}} and {{hl|monitorResolution}} are not provided on [[hasInterface|headless systems]] ([[isDedicated|dedicated]] servers and [[Arma 3: Headless Client|headless clients]]).}}
{{Feature|important|{{hl|vramInfo}} and {{hl|monitorResolution}} keys presence is not guaranteed.}}


|x1= <sqf>
|x1= <sqf>
Line 31: Line 31:
["hdrQuality", 16],
["hdrQuality", 16],
["hdrQualityName", "Normal"],
["hdrQualityName", "Normal"],
["monitorResolution", [0, 0, 2304, 1440]], // player PC only
["monitorResolution", [0, 0, 2304, 1440]], // presence not guaranteed
["objQualityName", "VeryLow"],
["objQualityName", "VeryLow"],
["objectVisibility", 800],
["objectVisibility", 800],
Line 60: Line 60:
["terrainQualityName", "Low"],
["terrainQualityName", "Low"],
["texQualityName", "VeryLow"],
["texQualityName", "VeryLow"],
["vramInfo", ["5.8 GiB", "7.9 GiB", "0 B", "231 MiB", "5.5 GiB"]], // player PC only
["vramInfo", ["5.8 GiB", "7.9 GiB", "0 B", "231 MiB", "5.5 GiB"]], // presence not guaranteed
["vsync", false],
["vsync", false],
["waterReflectionQualityName", "Disabled"]
["waterReflectionQualityName", "Disabled"]

Revision as of 12:18, 27 January 2023

Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.12.

Description

Description:
Obtain the current system's video settings.
Groups:
System

Syntax

Syntax:
getVideoOptions
Return Value:
HashMap - all video settings, the key is always a String, the value can be a String, Number, Boolean or Array (see Example 1).
vramInfo and monitorResolution keys presence is not guaranteed.

Examples

Example 1:
private _videoOptions = getVideoOptions; /* [ ["GPUName", "NVIDIA GeForce GTX 1660"], ["aspectRatioName", "Auto (Stretch)"], ["brightness", 1], ["cloudQualityName", "VeryLow"], ["displayModeName", "Window"], ["dynLightsCount", 4], ["dynLightsQualityName", "VeryLow"], ["gamma", 1], ["guiScale", 0.55], ["guiScaleName", "Small"], ["hdrQuality", 16], ["hdrQualityName", "Normal"], ["monitorResolution", [0, 0, 2304, 1440]], // presence not guaranteed ["objQualityName", "VeryLow"], ["objectVisibility", 800], ["overallPresetName", "VeryLow"], ["overallVisibility", 1000], ["particleQualityName", "Low"], ["pipQuality", 512], ["pipQualityName", "VeryLow"], ["pipVisibility", 835], ["ppBloom", 0], ["ppBrightness", 1], ["ppCausticsQualityName", "Disabled"], ["ppColorPresetName", "Default"], ["ppContrast", 1], ["ppDOF", 0], ["ppFSAA", 1] ["ppPPAAQualityName", "Disabled"], ["ppRadialBlur", 0], ["ppRotationBlur", 0], ["ppSSAOQualityName", "Disabled"], ["ppSaturation", 1], ["ppSharpenFilter", 0], ["refreshRate", 60], ["samplingPercentage", 100], ["shadowQualityName", "Low"], ["shadowVisibility", 100], ["terrainQuality", 25], ["terrainQualityName", "Low"], ["texQualityName", "VeryLow"], ["vramInfo", ["5.8 GiB", "7.9 GiB", "0 B", "231 MiB", "5.5 GiB"]], // presence not guaranteed ["vsync", false], ["waterReflectionQualityName", "Disabled"] ]; */

Additional Information

See also:
getResolution getAudioOptionVolumes getSubtitleOptions

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