add doc/*/libgfx-posteffects.md

This commit is contained in:
MihailRis
2025-07-10 18:47:28 +03:00
parent be5f43086d
commit a0dff3fef1
4 changed files with 80 additions and 2 deletions
@@ -0,0 +1,37 @@
# gfx.posteffects library
A library for post-processing effects control.
The effect slot is a resource and must be declared in resources.json in the root directory of the pack:
```json
{
"post-effect-slot": [
"slot_name"
]
}
```
```lua
-- Returns the index of the effect slot by name (pack:slot_name).
-- If the specified slot does not exist, returns -1
gfx.posteffect.index(name: str) --> int
-- Assigns the effect to the slot
gfx.posteffect.set(slot: int, effect: str)
-- Returns the effect intensity (from 0.0 to 1.0)
-- If the slot is empty, returns 0.0
gfx.posteffect.get_intensity(slot: int) --> number
-- Sets the effect intensity (from 0.0 to 1.0)
-- (The correctness of processing the parameter between 0.0 and 1.0
-- depends on the effect)
gfx.posteffect.set_intensity(slot: int, intensity: number)
-- Returns true if the slot is not empty and the effect intensity is non-zero
gfx.posteffect.is_active(slot: int) --> bool
-- Sets parameters values ('param' directives)
gfx.posteffect.set_params(params: table)
```