add doc/*/libgfx-posteffects.md

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
+
+Библиотека для работы с эффектами пост-обработки.
+
+Слот эффектов является ресурсом, и должен быть объявлен в resources.json в корневой директории пака:
+
+```json
+{
+    "post-effect-slot": [
+        "имя_слота"
+    ]
+}
+```
+
+```lua
+-- Возвращает индекс слота эффектов по имени (пак:имя_слота).
+-- При отсутствии указанного слота возвращает -1
+gfx.posteffect.index(name: str) --> int
+
+-- Назначает эффект на слот
+gfx.posteffect.set(slot: int, effect: str)
+
+-- Возвращает интенсивность эффекта (от 0.0 до 1.0)
+-- Если слот пуст, возвращает 0.0
+gfx.posteffect.get_intensity(slot: int) --> number
+
+-- Устанавливает интенсивность эффекта (от 0.0 до 1.0)
+-- (Корректность обработки параметра между значениями 0.0 и 1.0 зависит
+-- от эффекта
+gfx.posteffect.set_intensity(slot: int, intensity: number)
+
+-- Возвращает true если слот не пуст и интенсивность эффекта ненулевая
+gfx.posteffect.is_active(slot: int) --> bool
+
+-- Устанавливает значения параметров (директивы 'param')
+gfx.posteffect.set_params(params: table)
+```