fix: blur filter strength and deprecate old behavior #11576
Conversation
|
pixi.js-base • pixi.js-bunny-mark commit: |
There was a problem hiding this comment.
This PR is great, thanks so much for the fix.
One thing i would suggest is we make BlurPass 'dumb' to the deprication and instead pass in the param at construction eg '
new BlurPass({..., sqrtScaledStrength})
This would remove the need for any static variables on it.
We can the add a param to BlurFilterOptions and BlurFilter.defaultOptions.
static defaultOptions = {
...,
sqrtScaledStrength:true
}
we can then do a deprication check in the BlurFilter. The main reason for this is users do not tend to use or know about BlurFilterPass class and tend to work with the BLurFilter class only.
Let me know if this makes sense! Thanks!
|
I used static variable because it may be burdensome for project developers to add an additional option to each blur filter instance. What about using a static property of BlurFilter instead of BlurFilterPass? |
|
I agree with @UlyssesZh. A static option for deprecation is better because it means removing one line of code from your project at the next major release instead of tracking down all instances of BlurFilter. BlurFilter seems like a better location than the more internal BlurFilterPass. |
Closes #11554.
Description of change
Fix blur filter strength and deprecate old behavior. The old behavior is still the default, and the new behavior is enabled by setting the static property
BlurFilterPass.sqrtScaledStrength = true. Creating an instance ofBlurFilterPasswithout this flag emits a deprecation warning.Core change:
Now the standard deviation of the blurring effect is independent of the quality (number of passes) and the kernel size. The distribution defined in constant
GAUSSIAN_VALUES_FIXhas standard deviationsqrt(kernelSize - 1).Not sure if a visual scene test should be included.
Pre-Merge Checklist
npm run lint)npm run test)