Builtin Library
README.md
qualityLevels
The quality level an effect draws at, "low", "medium" or "high", and the
level the device's quality tier puts an effect at when content asks for
"auto".
local QualityLevels = require("@builtin::modules.qualityLevels")
print(QualityLevels.deviceLevel()) -- "high" on a desktop
print(QualityLevels.levelOf("auto")) -- the device's level
print(QualityLevels.scaled(40, 0.5, 4)) -- 20: a count drawn at half
Tier in force (renderer.qualityTier().tier) | Level an effect under "auto" draws at |
|---|---|
high, off a handheld (a desktop, a browser on one) | high |
high, on a handheld | medium |
medium | medium |
low | low |
"high" is an effect as authored; the lower levels draw it with a stated
share of that work. A level content names ("low", "medium", "high")
holds on every device; "auto" is read again whenever the effect asks, so
renderer.setQualityTier reaches every effect following the tier on its next
frame. check refuses anything else, naming the levels.
The volumetric effects read their levels here: VolumetricLighting,
PhysicalAtmosphere, ParticipatingMedium (through
mediaTransmittance.set), VolumetricSky and Volume, each with a quality
setting; the graphics-quality guide lists what each level draws and costs.