Документация
Docs/ru/reference/effect-format/index.md
Сгенерированный справочник формата эффектов
Сгенерированный справочник. Не редактируйте его напрямую. Обновите
BuildTools/EffectFormatInterface.json, затем выполнитеpython BuildTools/docs_effect_format.py --write.
| Индекс | Синтаксис | Состояние рендеринга | Ресурсы | Запекание | Runtime | Проверка | Канонический JSON | Руководство |
Этот справочник описывает переиспользуемый контракт Engine для авторинга .fofx, запекания, ресурсов рендерера, runtime-загрузки и управления из скриптов. Конкретные каталоги шейдеров, визуальная политика и значения слотов ScriptValue принадлежат проекту.
Состояние контракта
| Поле | Значение |
|---|---|
| Стабильность | experimental |
| Политика поддержки | Контракт генерируется для закреплённой ревизии Engine. Проекты владеют каталогами эффектов, визуальной политикой, профилями качества, конкретными путями переопределений и значениями слотов ScriptValue. |
| Исходный манифест | BuildTools/EffectFormatInterface.json |
| Дайджест контракта | bd50466bab9291d7b04d119f6fb9b613bc6507b1c771cef1605c7d7e7184aea0 |
| Расширение исходного файла | .fofx |
| Сторона runtime | client |
| Справочник | Записи | Назначение |
|---|---|---|
| Syntax | 4 | Обязательные и необязательные секции, а также fallback проходов. |
| Render state | 10 | Число проходов, смешивание, глубина, версия шейдера и состояние теней. |
| Resources | 12 resources / 4 limits | Форматы вершин, sampler-ы, встроенные uniform buffer-ы и привязки. |
| Baking | 8 | Окружение компилятора, reflection, форматы выходов и переназначение SDL. |
| Runtime | 7 rules / 4 methods | Выбор эффектов, кеширование, сохранение ScriptValue и обновления. |
Граница ответственности
Включено:
- секции конфигурации .fofx, fallback стадий шейдера, объявления проходов, состояние рендеринга, необязательные варианты глубины/culling для отдельных вызовов отрисовки и пролог компилятора шейдеров
- форматы входных вершин, распознаваемые sampler-ы, встроенные uniform buffer-ы, соглашения о дескрипторах, reflection и ограничения backend-ов
- запечённые артефакты каждого прохода для Vulkan, SDL_GPU, OpenGL, OpenGL ES, Direct3D и Metal
- runtime-загрузка, идентичность кеша по пути, выбор EffectUsage, сохранение script value, скриптовые методы и проверка
Исключено:
- проектные каталоги эффектов, художественные правила шейдеров, уровни качества и конкретная политика перекрытия ресурсов
- определяемые проектом индексы, диапазоны, владельцы, значения по умолчанию и игровая семантика ScriptValue
- общий справочник языка GLSL, оптимизация производительности GPU и отладка шейдеров конкретных производителей
- авторинг систем частиц, форматы изображений, запекание спрайтов, грамматика описаний моделей и компоновка GUI