Builtin Library
README.md
sharpening
Contrast-adaptive sharpening for the finished frame.
local Sharpening = require("@builtin::systems.sharpening.sharpening")
Sharpening.enable(0.5)
Most scenes attach ImageSharpening to an entity instead and let it drive this
module.
API
| Call | Effect |
|---|---|
set(opts) | Set the strength; omitted fields keep their value |
enable(sharpness?) | Turn sharpening on, optionally at a new strength |
disable() | Turn it off and release the pass |
get() | A copy of the settings in force |
active() | Whether the pass is running |
Settings
| Field | Meaning |
|---|---|
sharpness | How hard to sharpen, in [0, 1]. 0 releases the pass. |
sharpness interpolates the kernel's outer lobe between a gentle -0.125 and a
strong -0.2. It is a look control, not a quality tier — every value costs the
same.
Lifetime
The feature is created when sharpness first goes above zero and destroyed when
it returns to zero, so a scene that is not sharpening runs no pass at all and its
output is identical to a build without this package.