CameraFrame API in the engine #7129
Conversation
| * @property {string} type - The type of the SSAO determines how it is applied in the rendering | ||
| * process. Defaults to {@link SSAOTYPE_NONE}. Can be: | ||
| * | ||
| * - {@link SSAOTYPE_NONE} | ||
| * - {@link SSAOTYPE_LIGHTING} | ||
| * - {@link SSAOTYPE_COMBINE} | ||
| * |
There was a problem hiding this comment.
I personally have trouble understanding/visualizing the 3 SSAO types. I would prefer an enabled flag and have it do the most common or nicest looking code path, but provide a further flag along the lines of 'ignoreLighting' or something.
There was a problem hiding this comment.
I improved the descriptions here:
SSAOTYPE_LIGHTING:
- SSAO is applied during the lighting calculation stage, allowing it to blend seamlessly with scene
- lighting. This results in ambient occlusion being more pronounced in areas where direct light is
- obstructed, enhancing realism.
SSAOTYPE_COMBINE:
- SSAO is applied as a standalone effect after the scene is rendered. This method uniformly
- overlays ambient occlusion across the image, disregarding direct lighting interactions. While
- this may sacrifice some realism, it can be advantageous for achieving specific artistic styles.
There was a problem hiding this comment.
Barging in here, I'd prefer both an enabled property and a type property, defaulting to lighting? I wouldn't be suprised if theres a different ssao code path in the future so a type field might be nice
There was a problem hiding this comment.
if we implement different types of SSAO, it would be related to the type of generation of ssao texture.
The current type related to the way ssao texture is consumed by other passes.
So we'd add a different type for that I think.
| */ | ||
|
|
||
| /** | ||
| * @typedef {Object} Bloom |
There was a problem hiding this comment.
I can't help but feel that an enabled property per effect would make for a more logical, guessable API.
There was a problem hiding this comment.
currently only TAA and Grading has enabled property. Others have some form of intensity parameter, which disables it when set to 0.
It seems adding enabled there would require two parameters change to use it instead of just a single, so I'm not sure I like that.
|
I'll merge this for now, further feedback / changes will be address by a follow up PR @willeastcott |
Fixes #7129
(separate improvements / changes can be tracked separately)
This adds a new CameraFrame class as part of the engine, which is a public API for the currently exposed render pass based rendering.
The script which exposes this to the Editor now uses an instance of this CameraFrame, and simply passes attributes to it, without containing any logic. This allows it to not access any private engine functionality.
This is the new public API (too long to copy here)
https://github.com/playcanvas/engine/blob/mc-engine-camera-frame/src/extras/render-passes/camera-frame.js