Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:23Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Sets the brightness and gamma of the display.

<pre>
Settings.SetBrightnessAndGamma(brightness, gamma)
</pre>

== Arguments ==
;brightness : <code>number</code> – Brightness boost, from 0 to 0.5.
;gamma : <code>number</code> – Gamma value, from 1 to 4.

== Returns ==
Nothing.

== Details ==
* <code>brightness</code> is clamped to the range 0–0.5. A <code>gamma</code> below 1 or above 4 is replaced by 2.2.
* The client builds a gamma ramp from the two values (the same curve for red, green and blue) and hands it to the graphics device. If the renderer or its device does not exist yet, nothing happens.
* The function lives in the <code>Settings</code> table, so it is called as <code>Settings.SetBrightnessAndGamma</code>.
* The stock video settings tab calls it every time one of its two sliders moves, so the change can be seen at once. It passes the brightness slider position divided by 4 and the gamma slider position times 3 plus 1.
* The function needs at least two arguments and only reads the last two.

== Errors ==
None besides the ''Invalid Parameters'' message when an argument is not a number.

== Example ==
From <code>ea_settingswindow/source/settingswindowtabvideo.lua</code>:
<pre>
function SettingsWindowTabVideo.OnGammaChanged( ignored )
local brightness_boost = SliderBarGetCurrentPosition(SettingsWindowTabVideo.contentsName.."SettingsColorBrightnessSlider" ) / 4.0
local monitor_gamma = (SliderBarGetCurrentPosition(SettingsWindowTabVideo.contentsName.."SettingsColorGammaSlider" ) * 3.0) + 1.0
Settings.SetBrightnessAndGamma( brightness_boost, monitor_gamma )
end
</pre>

== See also ==
* [[API:Settings.HardwareSupportsPostProc|Settings.HardwareSupportsPostProc]]
* [[API:SliderBarGetCurrentPosition|SliderBarGetCurrentPosition]]

API:Settings.SetBrightnessAndGamma - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)