CameraFrame API in the engine #7129
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slimbuck
approved these changes
Nov 22, 2024
| * @typedef {Object} Bloom | ||
| * @property {number} intensity - The intensity of the bloom effect, 0-0.1 range. Defaults to 0, | ||
| * making it disabled. | ||
| * @property {number} lastMipLevel - The last mip level of the bloom effect, 0-12 range. Defaults to 1. |
There was a problem hiding this comment.
I struggle to understand what this will do. Can we expose this in a more obvious/friendly way?
Comment on lines
+36
to
+42
| * @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.
| */ | ||
|
|
||
| /** | ||
| * @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.
| * preference. Defaults to [{@link PIXELFORMAT_111110F}, {@link PIXELFORMAT_RGBA16F}, | ||
| * {@link PIXELFORMAT_RGBA32F}]. | ||
| * @property {boolean} stencil - Whether the render buffer has a stencil buffer. Defaults to false. | ||
| * @property {number} renderTargetScale - The scale of the frame buffer, 0.1-1 range. Defaults to 1. |
There was a problem hiding this comment.
Not obvious what this does.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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