Source Filter Transition Shader

Shader Source/Filter/Transition 🔴

StreamFX ships with three different ways to use custom shaders in OBS Studio: Source Shader, Filter Shader and Transition Shader. Each has slightly different usage, but can mostly work with almost the same shader and allows you to easily use your own or someone elses shaders in OBS Studio. Shaders allow for quick iteration and enable some effects that were previously impossible.

Version Information

Status	Version
🔴Added	0.5
🟠Unstable	N/A
🟢Stable	N/A
⚠️Deprecated	N/A
❌Removed	N/A

Settings

TODO

Shader Language

The Shader integration uses OBS's Shading Language, which is documented here. The Shader integration uses specific uniforms as well as annotations to determine what something is.

Syntax

The [] denote optional things, while the () denote required things. They are only used to illustrate the structure itself, and must be removed.

Generic Parameters

uniform (type) (name)<
  // 'true' to allow Users to see this parameters, 'false' to hide it. Enables invisible parameters which do special things with scripts.
  [bool visible = true;]
  // 'true' to completely disallow modification from outside. Useful for predefined parameters and values that are spread from other parameters.
  [bool automatic = false;]
  // Name used in the UI.
  [string name = "Name";]
  // Description used in the UI.
  [string description = "Description";]
  // DANGEROUS: Override the detected type with a specific one. Do not use unless you absolutely need it.
  [string type = "bool";] // Turn this into a boolean.
  [string type = "float";] // Turn this into a float.
  [string type = "int";] // Turn this into an integer.
  [string type = "string";] // Turn this into a string.
  [string type = "texture";] // Turn this into a texture.
  [string type = "sampler";] // Turn this into a sampler.
  // DANGEROUS: Override the detected size with a specified one. Do not use unless you absolutely need it.
  [int size = 1;]
>[ = (value)];

Value Parameters

A value parameter is one of the following types: float, float#, float[], float#x#, int, int#, int[], int#x#, uint, uint#, uint[], uint#x#, bool, bool#, bool[], bool#x#. Some types may require type and size overrides in order to be detected correctly.

uniform (type) (name)<
  // ... continued from Generic Parameters
  // Changes the field type to a different one.
  [string field_type = "input";]       // Standard input widget with manual entry and nothing fancy.
  [string field_type = "slider";]      // Horizontal slider with manual entry option.
  [string field_type = "enum";]        // Dropdown with enumeration entries, see "Value Enumeration".
  // Suffix for the values.
  [string suffix = " my awesome suffix";]
  // Minimum value that can be set.
  [(type) minimum = {...};] // Defaults to the smallest possible number.
  // Maximum value that can be set.
  [(type) maximum = {...};] // Defaults to the largest possible number.
  // The step of the value.
  [(type) step = {...};] // Defaults to 1.
  // The scale of the value, which is applied to everything. Can be used to greatly increase the precision of an property.
  [(type) scale = {...};] // Defaults to 1.
>[ = (value)];

Value Enumeration

A subset of value parameters where the selection is limited to a defined list of values, which can be defined in the shader. This can be useful to have users select from certain behavior instead of requiring them to enter numbers manually.

Entries in the list are limited to int, float and string, the three basic types of parameters. Vector types will simply act as an array of the basic type, and show a dropdown for each vector part. A float4 for example would allow the user to pick a value for r, g, b and a (or x, y, z and w).

uniform (type) (name)<
  // ... continued from Generic Parameters
  // Set the field type to enumeration.
  [string field_type = "enum";]        // Dropdown with enumeration entries.
  // Defines the #. enumeration entry of the list. # must be a continuously increasing number starting from 0.
  [(base type) enum_# = (value);] // The value of the enumeration entry.
  [string enum_#_name = "(name)";] // The name of the enumeration entry, optional. If not specified, defaults to "Unnamed Entry".
>[ = (value)];

Texture Parameters

A texture parameter specifies a static image, or a different source to be provided to your shader.

uniform texture2d (name)<
  // ... continued from Generic Parameters
  // Changes the field type to a different one.
  [string field_type = "input";]       // Standard input widget with manual entry and nothing fancy.
  [string field_type = "enum";]        // Dropdown with enumeration entries, see "Texture Enumeration".
>[ = (value)];

Texture Enumeration

Extended from Texture Parameters, enumerations allow you to specify a predefined list of allowed textures that users can use with your shader. You specify a list of entries with file names relative to your shader, from which the user can then choose from.

uniform texture2d (name)<
  // ... continued from Texture Parameters
  // Set the field type to enumeration.
  [string field_type = "enum";]        // Dropdown with enumeration entries.
  // Defines the #. enumeration entry of the list. # must be a continuously increasing number starting from 0.
  [string enum_# = (value);] // The relative path to the file that should be loaded as a texture.
  [string enum_#_name = "(name)";] // The name of the enumeration entry, optional. If not specified, defaults to "Unnamed Entry".
>[ = (value)];