How qianmo/x-postprocessing-library works
Project type and purpose
• Type: Unity engine extension / open-source post-processing effects library.
A. Unity Editor & Play Mode
• The central “host” application.
B. Built-in PostProcessing Stack v2
• Lives under Assets/PostProcessing-2
• Provides the pipeline and base classes.
C. XPL Package (Assets/X-PostProcessing)
1. Editor Extensions
• Editor scripts (.cs under Editor folder)
• Adds “Add effect…” menu items, effect custom inspectors.
2. Runtime Code
• Effect Settings & Renderers (.cs under Runtime folder)
• ParameterOverride, Utils, PostProcessBundle, Manager.
3. Shaders
• GPU code (.hlsl, .shader under Shaders folder)
4. Effects
• Individual effect folders (e.g. GaussianBlur, GlitchRGBSplitV5…)
• Each has C# setting, editor UI, and shader asset.
5. Utility & Profiles
• Utility helper classes, sample profiles (.asset).
D. Example Scene
• Assets/Example/ExampleScene.unity
• Demonstrates a PostProcessVolume with an XPL profile.
E. External Dependencies
• Unity engine runtime
• GPU (to run shaders)
Relationships & Data flows
1. Editor side:
• Unity Editor → Editor Extensions (menu/UI) → modifies ScriptableObject profiles.
2. Build/Play:
• Example Scene contains a PostProcessVolume → holds a PostProcessProfile asset.
• PostProcessing Stack v2 runtime pipeline → invokes XPL Runtime Code:
• Reads Effect Settings → instantiates corresponding EffectRenderer.
• EffectRenderer dispatches GPU shader passes.
• GPU executes Shaders → writes to camera render target.
3. Utility classes support both Editor and Runtime.
Architectural patterns & principles
• Plugin architecture: clear Editor vs. Runtime separation.
• ScriptableObject-based configuration (profiles & settings).
• Dependency injection into Unity’s existing PostProcessing pipeline.
• Modular effect sub-folders for extensibility.
Detailed elements
• Unity Editor (blocks: Editor UI, Play Mode).
• Assets/PostProcessing-2 (pipeline provider).
• Assets/X-PostProcessing:
• Editor folder (menu & inspectors).
• Runtime folder (effect logic).
• Shaders folder (GPU code).
• Effects sub-folders.
• Utility + Profiles.
• ExampleScene.unity → demonstrates usage.
• How Profile → Runtime Code → Shader → GPU → Framebuffer.
• How Editor Extensions → Profiles.