You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add new standard parameters (loops, local time, 2 new random numbers)
Update UI
Update filter templates
Add fire shader
Add matrix effect
Add Night Sky background
Update Readme
Copy file name to clipboardexpand all lines: README.md
+29-16
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# obs-shaderfilter 1.11
1
+
# obs-shaderfilter 1.2
2
2
3
3
## Introduction
4
4
@@ -51,7 +51,7 @@ that need to render outside the bounds of the original source.
51
51
52
52
Normally, all that's required for OBS purposes is a pixel shader, so the plugin will wrap your shader text with a
53
53
standard template to add a basic vertex shader and other boilerplate. If you wish to customize the vertex shader
54
-
or other parts of the effect for some reason, you can check the "Override entire effect" option.
54
+
or other parts of the effect for some reason, you can check the "Use Effect File (.effect)" option.
55
55
56
56
Any parameters you add to your shader (defined as `uniform` variables) will be detected by the plugin and exposed
57
57
in the properties window to have their values set. Currently, only `int`, `float`, `bool`, `string`, `texture2d`, and `float4`
@@ -77,8 +77,12 @@ handle these variables being missing, but the shader may malfunction.)
77
77
***`image`** (`texture2d`)—The image to which the filter is being applied, either the original output of
78
78
the source or the output of the previous filter in the chain. (Standard for all OBS filters.)
79
79
***`elapsed_time`** (`float`)—The time in seconds which has elapsed since the filter was created. Useful for
80
-
creating animations.
81
-
***`rand_f`** (`float`)— a random float between 0 and 1.
80
+
creating animations.
81
+
***`local_time`** (`float`)— a random float representing the local time.(1.2)
82
+
***`loops`** (`int`)— count of how many loops times the shader has rendered a page.(1.2)
83
+
***`rand_f`** (`float`)— a random float between 0 and 1. changes per frame.
84
+
***`rand_activation_f`** (`float`)— a random float between 0 and 1. changes per activation, load or change of settings.(1.2)
85
+
***`rand_instance_f`** (`float`)— a random float between 0 and 1. changes per instance on load.(1.2)
82
86
***`uv_offset`** (`float2`)—The offset which should be applied to the UV coordinates of the vertices. This is
83
87
used in the standard vertex shader to draw extra pixels on the borders of the source.
84
88
***`uv_scale`** (`float2`)—The scale which should be applied to the UV coordinates of the vertices. This is
@@ -89,8 +93,10 @@ handle these variables being missing, but the shader may malfunction.)
89
93
texture, or otherwise scale UV coordinate distances into texel distances.
90
94
91
95
### New Options in version 1.1+
92
-
**Use Slider Inputs— Converts Integer and floating point inputs into sliders in the UI.
93
-
**Use Shader Time—Start the effect from the loadtime of the shader, not the start up time of OBS Studio.
96
+
***`Use Slider Inputs`**— Converts Integer and floating point inputs into sliders in the UI.
97
+
***`Use Shader Time`**—Start the effect from the loadtime of the shader, not the start up time of OBS Studio.
98
+
***`Override Entire Effect`** renamed **`Use Effect File (.effect)`** in UI and documentation
99
+
* Textures moved from the shaders folder to the textures folder. Existing textures are not deleted so as to not disrupt you current scenes.(1.2)
94
100
95
101
### Example shaders
96
102
@@ -102,29 +108,36 @@ loaded.
102
108
I recommend *.shader* as they do not require `override_entire_effect` as pixel shaders, while *.effect* signifies vertex shaders with `override_entire_effect` required.
103
109
104
110
**animated_texture.effect*— Animates a texture with polar sizing and color options
111
+
**ascii.shader*— a little example of ascii art
105
112
**background_removal.effect*— simple implementation of background removal. Optional color space corrections
106
113
**blink.shader*—A shader that fades the opacity of the output in and out over time, with a configurable speed
107
114
multiplier. Demonstrates the user of the `elapsed_time` parameter.
108
115
**bloom.shader / glow.shader*— simple shaders to add glow or bloom effects, the glow shader has some additional options for animation
109
-
**cartoon.effect* (Overrides entire effect)— Simple Cartooning based on hue and steps of detail value.
116
+
**cartoon.effect* (Use Effect File (.effect))— Simple Cartooning based on hue and steps of detail value.
110
117
**border.shader*—A shader that adds a solid border to all extra pixels outside the bounds of the input.
111
118
**drop_shadow.shader*—A shader that adds a basic drop shadow to the input. Note that this is done with a simple
112
119
uniform blur, so it won't look quite as good as a proper Gaussian blur. This is also an O(N²) blur on the size
113
120
of the blur, so be very conscious of your GPU usage with a large blur size.
114
121
**edge_detection.shader*—A shader that detects edges of color. Includes support for alpha channels.
115
-
**filter_template.effect* (Overrides entire effect)—A copy of the default effect used by the plugin, which simply
122
+
**filter_template.effect* (Use Effect File (.effect))—A copy of the default effect used by the plugin, which simply
116
123
renders the input directly to the output after scaling UVs to reflect any extra border pixels. This is useful as a starting
117
124
point for developing new effects, especially those that might need a custom vertex shader. (Note that modifying this file will
118
125
not affect the internal effect template used by the plugin.)
126
+
**filter_template.shader*—A copy of the default shader used by the plugin, which simply
127
+
renders the input directly to the output after scaling UVs to reflect any extra border pixels. This is useful as a starting
128
+
point for developing new pixel shaders. (Note that modifying this file will not affect the internal effect template used by the plugin.)
129
+
**fire.shader*— A fire example converted from shadertoy
119
130
**gradient.shader*— This shader has a little brother *simple_gradient.shader*, but lets you choose three colors and animate gradients.
120
131
**glitch_analog.shader*—A shader that creates glitch effects similar to analog signal issues. Includes support for alpha channel.
121
132
**hexagon.shader*—A shader that creates a grid of hexagons with several options for you to set. This is an example of making shapes.
122
133
**luminance.shader*—A shader that adds an alpha layer based on brightness instead of color. Extremely useful for making live
123
134
video special effects, like replacing backgrounds or foregrounds.
135
+
**matrix.effect*— The cat is a glitch conversion from shadertoy. Updated with several configurable options.(1.2)
124
136
**multiply.shader*—A shader that multiplies the input by another image specified in the parameters. Demonstrates the use
125
137
of user-defined `texture2d` parameters.
126
-
**perlin_noise.effect* (Overrides entire effect)—An effect generates perlin_noise, used to make water, clouds and glitch effects.
127
-
**pulse.effect* (Overrides entire effect)—An effect that varies the size of the output over time. This demonstrates
**perlin_noise.effect* (Use Effect File (.effect))—An effect generates perlin_noise, used to make water, clouds and glitch effects.
140
+
**pulse.effect* (Use Effect File (.effect))—An effect that varies the size of the output over time. This demonstrates
128
141
a custom vertex shader that manipulates the position of the rendered vertices based on user data. Note that moving the vertices
129
142
in the vertex shader will not affect the logical size of the source in OBS, and this may mean that pixels outside the source's
130
143
bounds will get cut off by later filters in the filter chain.
@@ -134,14 +147,14 @@ I recommend *.shader* as they do not require `override_entire_effect` as pixel s
134
147
Pixels inside the bounds of the input are treated as solid; pixels outside are treated as opaque. The complexity of the blur
135
148
does not increase with its size, so you should be able to make your blur size as large as you like wtihout affecting
136
149
GPU load.
137
-
**repeat.effect* (Overrides entire effect)—Duplicates the input video as many times as you like and organizes on the screen.
150
+
**repeat.effect* (Use Effect File (.effect))—Duplicates the input video as many times as you like and organizes on the screen.
138
151
**rgb_color_wheel.shader—A rotatable RGB color wheel!
139
-
**rotatoe.effect* (Overrides entire effect)—A test rotation effect
152
+
**rotatoe.effect* (Use Effect File (.effect))—A test rotation effect
140
153
**rounded_rect.shader*—A shader that rounds the corners of the input, optionally adding a border outside the rounded
141
154
edges.
142
155
**scan_line.shader*—An effect that creates old style tv scan lines, for glitch style effects.
143
156
**selective_color.shader*—Create black and white effects with some colorization. (defaults: .4,.03,.25,.25, 5.0, true,true, true, true. cuttoff higher = less color, 0 = all 1 = none)
144
-
**shake.effect* (Overrides entire effect)—creates random screen glitch style shake. Keep the random_scale low for small (0.2-1) for small
157
+
**shake.effect* (Use Effect File (.effect))—creates random screen glitch style shake. Keep the random_scale low for small (0.2-1) for small
145
158
jerky movements and larger for less often big jumps.
146
159
**spotlight.shader*—Creates a stationary or animated spotlight effect with color options, speed of animation and glitch
147
160
**shine.shader*—Add shine / glow to any element, use the transition luma wipes (obs-studio\plugins\obs-transitions\data\luma_wipes *SOME NEW WIPES INCLUDED IN THIS RELEASE ZIP*) or create your own,
@@ -151,7 +164,7 @@ I recommend *.shader* as they do not require `override_entire_effect` as pixel s
**zoom_blur.shader*—A shader that creates a zoom with blur effect based on a number of samples and magnitude of each sample. It also includes
153
166
an animation with or without easing and a glitch option. Set speed to zero to not use animation. Suggested values are 15 samples and 30-50 magnitude.
154
-
**other*—I have far too many shaders to list. Please check [Examples folder](https://github.com/Oncorporation/obs-shaderfilter/tree/master/data/examples)
167
+
**other*—We have far too many shaders to list. Please check [Examples folder](https://github.com/Oncorporation/obs-shaderfilter/tree/master/data/examples)
155
168
or find me on discord, as I have many additional filters for fixing input problems.
156
169
157
170
## Building
@@ -180,5 +193,5 @@ mess to deal with and I don't like it.
180
193
181
194
## Donations
182
195
183
-
I appreciate donations on twitch.tv/surn , [Bitcoin](bitcoin:3HAN6eVxv81URgj51wxeCd9eMhg3tvriro) or [LiteCoin](litecoin:MQFVTFCZUtcucZJzQCyiSDTirrWGqTyCjM).
184
-
Why Crypto? You do not have free speech when you live in fear of everything being taken away on an authoritarian whim, a criminal plot or by a outraged mob.
196
+
I appreciate donations/follows/subs on twitch.tv/surn , [Bitcoin](bitcoin:3HAN6eVxv81URgj51wxeCd9eMhg3tvriro) or [LiteCoin](litecoin:MQFVTFCZUtcucZJzQCyiSDTirrWGqTyCjM).
197
+
Why Crypto? We do not have free speech when we live in fear of everything being taken away on an authoritarian whim, a criminal plot or an outraged mob?
0 commit comments