search

Vhonowslend / StreamFX-Public

StreamFX is a plugin for OBS® Studio which adds many new effects, filters, sources, transitions and encoders! Be it 3D Transform, Blur, complex Masking, or even custom shaders, you'll find it all here.
https://streamfx.vhonowslend.com
GNU General Public License v2.0
3.94k stars 3.03k forks source link

"SDF Effects" filter is undocumented #512

Closed fhars closed 1 year ago

fhars commented 3 years ago

Description

I'd like to read https://github.com/Xaymar/obs-StreamFX/wiki/Filter-SDF-Effects linked from the main wiki page to understand how that filter works, but that page doesn't exist. I tried to apply that filter to some random source, and as far as I can tell none of the parameters of that filter has any visible effect on anything at all with that source, so it clearly needs some documentation on what it is for and how it is intended to be used.

System Information

All / Any / Whatever

skeletonbow commented 3 years ago

The filter can only be used with sources that contain transparent pixels (alpha channel) and do not fill the entire texture, as it operates on the boundary between opaque pixels and transparent ones, a common misunderstanding of this filter it seems. So if you use it on a fully opaque texture, there are no transparent pixels and it can't do anything. Once used on a transparent source, such as a chroma keyed webcam, or an image with a transparent background, the filter's effects become fairly obvious from tinkering with the controls however.

Note that the SDF filter can be quite GPU intensive so keep an eye on GPU usage in Task Manager or some other tool that can monitor usage, to ensure GPU usage of this effect is not overused as that can potentially interfere with games and/or OBS performance.

Xaymar commented 3 years ago

Most of the undocumented features have tooltips, but are still Experimental at best. As explained in the FAQ, experimental features are likely to break unexpectedly, so any documentation will be invalid by the time it's Unstable/Stable (if it even reaches that stage).

Xaymar commented 3 years ago

SDF Effects will most likely be removed or replaced with more efficient tools. As it is, SDF Effects have no chance of being GPU friendly due to their Scatter+Gather requirement.

Xaymar commented 1 year ago

SDF Effects will be deprecated with v0.12, and be replaced with better effects in v0.13. Closing as not planned.