VFX Toolkit

https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits
Admin
A comprehensive toolkit for creating visual effects, offering features like shader structures,...
Tokens:7,392
Snippets:45
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Basic HDRP Setup for Seaside Studios VFX Toolkit

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/setup-and-render-pipelines

This section details the initial steps required to set up the Seaside Studios VFX Toolkit asset for use with Unity's High Definition Render Pipeline (HDRP). It covers ensuring HDRP installation, importing the correct asset package, and optionally removing old shaders to prevent errors.

```Unity Configuration
1. Make sure that HDRP is properly installed on the project by either creating a HDRP project in Unity Hub or by going into the Package Manager, installing High Definition RP, creating a Pipeline Asset and finally assigning it to the Graphics Settings tabs
2. Import the “ImportHdrpPackage” Unity Package included in the asset root folder. Note that there are 2 of them “ImportHdrpPackage(pre2020)” and “ImportHdrpPackage(2020plus)”. Choose the appropriate one according to the Unity Editor version you are using.
3. You can delete the Built-In shaders (AllIn1VfxBuiltIn and AllIn1VfxGrabPass) to avoid error messages down the line
```

--------------------------------

### Configure VFX Asset for Unity Built-In Pipeline

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/setup-and-render-pipelines

This section outlines the necessary steps to set up a VFX asset within Unity's Built-In Render Pipeline, including installing post-processing, enabling HDR, and configuring camera and volume components to match promotional material visuals.

```Unity Configuration
1. Install Post Processing package from the Package Manager
2. In Project Settings, Graphics Settings enable HDR in all checkboxes
3. Make sure you allow HDR in you camera
4. Add Post Process Layer and Volume component
5. Add the included AllIn1VfxPp Profile to the Volume component
6. Properly configure them make making it Global and setting the Layer to the same Layer of the Camera you are using
```

--------------------------------

### Configure Demo Scene for HDRP in Seaside Studios VFX Toolkit

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/setup-and-render-pipelines

This step is necessary if you wish to use the included demo scene with HDRP. Be aware that the demo materials were not designed for HDRP, so the visual results will differ significantly from promotional materials. It involves changing the default volume profile asset.

```Unity Configuration
1. Change the Default Volume Profile Asset to AllIn1PostProcessingHDRP
```

--------------------------------

### Configure VFX Asset for Unity URP Pipeline

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/setup-and-render-pipelines

This section details the steps to integrate and configure a VFX asset for Unity's Universal Render Pipeline (URP), covering URP installation, pipeline asset configuration, package import, shader management, color space settings, and specific considerations for the 2D Renderer.

```Unity Configuration
1. Make sure that URP is properly installed on the project by either creating a URP project in Unity Hub or by going into the Package Manager, installing Universal RP, creating a Pipeline Asset and finally assigning it to the Graphics Settings tabs.
2. Select the Pipeline Asset (create one if needed and assign it on Project Settings -> Graphics) and make sure that both Depth Texture (used by Soft Particles and Intersection Glow effects) and Opaque Texture (used by Screen Distortion effect) are enabled:
3. Import the appropriate URP package from the asset root folder:
   * For standard URP: "ImportUrpPackage.unitypackage"
   * For 2D Renderer: "Import2DRenderer.unitypackage"
   Note: When using the 2D Renderer, be aware that Soft Particles, Intersection Glow, and Screen Distortion features are not supported due to fundamental limitations of Unity's 2D Renderer architecture.
4. You can delete the Built-In shaders (AllIn1VfxBuiltIn and AllIn1VfxGrabPass) to avoid error messages down the line:
5. Set Color Space to Gamma in Player Settings, Other Settings, Color Space. This is OPTIONAL, choosing a Color Space is an important project decision. Gamma is recommended just to get the same Demo results as in the store page.
6. This step is optional and only recommended for users using the URP 2D Renderer. In that case you’ll want to use the feature below the Materials Shader Auto Setup, the Disable Depth And Scene Color effects from materials to deactivate 3 effects that are incompatible with the 2D Renderer:
7. You can now open the DemoUrp Scene and everything will look like in the promotion material. In case it doesn’t look exactly the same it means that you are in a more recent URP version where the Post Processing Bloom implementation has been changed. You can play around with the Bloom values in the Camera GameObject Volumes Component.
```

--------------------------------

### Shape 1 Mask Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Prevents Shape1 from being affected by other shapes and distortions. This is used to keep certain parts of the shape intact, for example in a trail to make sure the beginning of the trail has no gaps.

```APIDOC
Shape 1 Mask Texture (_Shape1MaskTex):
  Description: Mask that tells the shader what parts of Shape 1 to keep.
  Values:
    White: Keep Shape 1 intact.
    Black: Keep shape result.
    In-between: Blended values.
Shape 1 Mask Power (_Shape1MaskPow):
  Description: Exponent of the Mask Texture, used to fine tune the results.
```

--------------------------------

### AllIn1Vfx Shader Properties Reference

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Detailed reference for all customizable properties and effects within the AllIn1Vfx shader, including global settings and shape-specific adjustments. Each entry includes the property name for scripting and, where applicable, the shader keyword for runtime activation.

```APIDOC
AllIn1Vfx Shader:
  Description: Custom Material Inspector allows activation/deactivation of effects and modification of properties.
  Performance: Effects only cost performance when enabled; otherwise, code is not compiled.
  Reset Button: 'R' button resets properties to default values.
  Keywords & Properties: Shader keyword names (e.g., [GLOW_ON]) for runtime enable/disable; Shader property names (e.g., _MainTex) for scripting.

  Global Properties:
    _Color:
      Type: Color
      Description: The Global Tint color.
    _Alpha:
      Type: Float
      Description: Global Transparency.

  Shape Properties and Effects:
    Note: 'N' denotes shape number (1, 2, 3). Shape 1 omits 'N' in property names (e.g., _ShapeColor), but not in effect keywords (e.g., SHAPE1CONTRAST_ON).

    _MainTex:
      Type: Texture
      Description: Shape 1 Texture. Automatically assigned in Sprite Renderers and UI Image components. Base shape texture for combination.
    _Shape2Tex:
      Type: Texture
      Description: Shape 2 Texture. Combines with Shape 1 and Shape 3. Set via material inspector.
    _Shape3Tex:
      Type: Texture
      Description: Shape 3 Texture. Combines with Shape 1 and Shape 2. Set via material inspector.
    _ShapeNColor:
      Type: Color (HDR)
      Description: Tint Color of the Shape Texture. Applied before combining shapes. HDR allows affecting color intensity and glow.
    _ShapeNXSpeed:
      Type: Float
      Description: Scrolls the shape texture over time on the X-axis. Higher value means faster scroll.
    _ShapeNYSpeed:
      Type: Float
      Description: Scrolls the shape texture over time on the Y-axis. Higher value means faster scroll.

    Effect: ShapeN Contrast [SHAPE_N_CONTRAST_ON]
      Description: Applies contrast and brightness to the shape texture before mixing and applying other effects.
      Properties:
        _ShapeNContrast:
          Type: Float
          Description: High values mean high contrast, low values mean low contrast (shape texture turns gray when untinted).
        _ShapeNBrightness:
          Type: Float
          Description: Brightness amount added to the shape texture.

    Effect: ShapeN Distortion [SHAPE_N_DISTORT_ON]
      Description: Distorts the shape texture before mixing and applying other effects.
      Properties:
        _ShapeNDistortTex:
          Type: Texture
          Description: Noise texture determining the distortion pattern.
        _ShapeNDistortAmount:
          Type: Float
          Description: Amount of image distortion following the distortion texture pattern.
        _ShapeNDistortXSpeed:
          Type: Float
          Description: Scroll speed of the distortion texture on the X-axis.
        _ShapeNDistortYSpeed:
          Type: Float
          Description: Scroll speed of the distortion texture on the Y-axis.

    Effect: ShapeN Rotation [SHAPE_N_ROTATE_ON]
      Description: Rotates the shape texture, independent of tiling and offset.
      Properties:
        _ShapeNRotationOffset:
          Type: Float (radians)
          Description: Initial rotation of the shape texture. Applied before rotation over time.
        _ShapeNRotationSpeed:
          Type: Float (radians)
          Description: Speed at which the shape texture turns.
```

--------------------------------

### Hue Shift and Saturation Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Outlines properties for adjusting hue, saturation, and brightness of colors.

```APIDOC
Hue Shift and Saturation [HSV_ON]:
  Properties:
    Hue Shift (_HsvShift):
      Description: How much the colors will be shifted
    Hue Shift Saturation (_HsvSaturation):
      Description: Saturation of the hue shift result
    Hue Shift Bright (_HsvBright):
      Description: Brightness of the hue shift result
```

--------------------------------

### ShapeN Properties: Texture and UV Controls

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Describes various properties for controlling shape textures, their alpha, screen position UVs, and debug visualization within the VFX toolkit.

```APIDOC
ShapeN RGB is Shape Color, Red Channel Is Alpha [SHAPE_N_SHAPECOLOR_ON]:
  Description: When enabled the greyscale value from 0 to 1 of the red channel of the shape texture gets used as the alpha (transparency) of the shape texture and the RGB of the shape will be the Shape N Color property
ShapeN Screen Position UVs [SHAPE_N_SCREENUV_ON]:
  Description: When enabled the shape texture will be samples using screen space coordinates instead of the model or quad UVs
  Properties:
    Scale With Dist Amount (_ScreenUvShNDistScale):
      Description: If set to 1 the screen space UVs will scale the further/closer we get, so the shape texture will have a constant size. If 0 it will look as if the shape texture shrinks and expands as we get further/closer
ShapeN Debug [SHAPEDEBUG_ON]:
  Description: When enabled only the current shape we have toggled will be rendered. This is extremely useful to see how each shape looks before combining with the other shapes and before applying effects
ShapeN RGB Weight (_ShapeNColorWeight):
  Description: Affects how the shape RGB will be combined with other shapes RGB. See Shader Structure and Usage section for more detailed info
ShapeN A Weight (_ShapeNAlphaWeight):
  Description: Affects how the shape alpha (A) will be combined with other shapes alpha. See Shader Structure and Usage section for more detailed info
```

--------------------------------

### Camera Distance Fade [CAMDISTFADE_ON]

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Explains properties for fading the global result based on camera proximity.

```APIDOC
Far Fade Start Point (_CamDistFadeStepMin): At this distance from the cam the material will start to fade
Far Fade End Point (_CamDistFadeStepMax): At this distance from the cam the material will be completely faded
Close Fade Start Point (_CamDistProximityFade): When the camera is closer than this distance the material will start fading
```

--------------------------------

### Posterize Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Limits the amount of colors creating a banding effect.

```APIDOC
Posterize Number of Colors (_PosterizeNumColors):
  Description: The higher the number the more different colors the material will display.
```

--------------------------------

### Wave (WAVEUV_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Distorts textures with waves that scroll from left to right. Parameters allow control over the number of waves, their speed, strength, and origin position.

```APIDOC
Wave (WAVEUV_ON):
  _WaveAmount: Defines the number of waves.
  _WaveSpeed: Controls the scrolling speed of the waves.
  _WaveStrength: Determines the intensity of the wave effect on textures.
  _WaveX: X-axis position of the wave origin (0 is left, 1 is right).
  _WaveY: Y-axis position of the wave origin (0 is bottom, 1 is top).
```

--------------------------------

### Glow Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Details the properties for configuring the Glow effect, which requires Post Processing Bloom for optimal visuals.

```APIDOC
Glow [GLOW_ON]:
  Dependencies: Needs Post Processing Bloom for better visuals
  Properties:
    Glow Color (_GlowColor):
      Description: Color of the Glow, has HDR and can also affect how bright the material shines by increasing the HDR intensity
    Glow Intensity (_Glow):
      Description: Indicates how bright the Glow Color will shine
    Glow Global Intensity (_GlowGlobal):
      Description: Indicates how bright the global result will shine
    Glow Texture (_GlowTex):
      Description: Acts as a mask. The glow will only be applied where the alpha of this texture is greater than 0
```

--------------------------------

### Alpha Remap [ALPHASMOOTHSTEP_ON]

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Defines properties for remapping the global result alpha to a custom range using a smoothstep function.

```APIDOC
Smoothstep Min (_AlphaStepMin): Low bound of the new alpha range, where the previous alpha was 0 now it will be Smoothstep Min
Smoothstep Max (_AlphaStepMax): High bound of the new alpha range, where the previous alpha was 1 now it will be Smoothstep Max. Everything in between gets interpolated
```

--------------------------------

### Color Effects: General Overview

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Introduces a category of effects that apply color changes to the combined shape result.

```APIDOC
Color Effects: These effects apply color changes to the shape combination result
```

--------------------------------

### Rim Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Properties related to controlling rim lighting effects on a material.

```APIDOC
Add Amount (_RimAmount):
  Description: Controls how the rim color is applied.
  Values:
    0: Rim color multiplied against shape result (useful for not affecting darker parts, follows texture).
    1: Rim color added, always visible regardless of shape color.
    In-between: Interpolation between both results.
Rim Erodes Alpha (_RimErodesAlpha):
  Description: Increase this value and set Rim Intensity to 0 to fade the model rim.
```

--------------------------------

### Shake (SHAKEUV_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Applies a shaking effect to all texture coordinates, creating a dynamic, jittery visual.

```APIDOC
Shake (SHAKEUV_ON): Shakes all texture coordinates.
```

--------------------------------

### Global Distortion [DISTORT_ON]

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Details properties for distorting all textures used by the shader.

```APIDOC
Distortion Texture (_DistortTex): Noise texture that determines how the distortion is done
Distortion Amount (_DistortAmount): How much the image is distorted following the texture pattern
```

--------------------------------

### Color Grading Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Describes the Color Grading effect, a lightweight alternative to Color Ramp that interpolates results across three input colors.

```APIDOC
Color Grading [COLORGRADING_ON]:
  Description: Similar to Color Ramp but more lightweight and slightly more limited. It works just like Color Ramp but it interpolates the result color across 3 input colors instead of a full gradient
  Properties:
    Light Color Tint (_ColorGradingLight):
      Description: Equivalent to the very right of the color ramp. Light color values will be mapped to this color
    Mid Tone Color Tint (_ColorGradingMiddle):
      Description: Equivalent to the center of the color ramp. Middle range color values will be mapped to this color
    Dark/Shadow Color Tint (_ColorGradingDark):
      Description: Equivalent to the very left of the color ramp. Dark color values will be mapped to this color
    Mid Point (_ColorGradingMidPoint):
      Description: Used to skew the result towards the Light Color or the Dark Color input
```

--------------------------------

### Color Ramp Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Explains properties for the Color Ramp effect, which maps shape colors to a gradient, supporting both static textures and live editable gradients.

```APIDOC
Color Ramp [COLORRAMP_ON]:
  Description: Takes a gradient as an input and maps the color of the shapes result to this gradient. When the Material is Saved To Folder we can use a live editable gradient instead of a static gradient texture
  Properties:
    Color Ramp Texture (_ColorRampTex):
      Description: Static gradient texture that the user needs to provide. The resulting colors will get mapped to this gradient. Dark colors will get mapped to the left of the gradient and bright colors to the right of the gradient
    Color Ramp Luminosity (_ColorRampLuminosity):
      Description: This will get added to the greyscale value the shader uses to map the colors. The higher this value the more we’ll skew results to the right of the gradient
    Color Ramp Gradient (_ColorRampTexGradient):
      Description: If the Material is Saved To Folder and the Use Editable Gradient box is toggled this property can be used to dynamically edit and create a gradient color
    Color Ramp Blend (_ColorRampBlend):
      Description: Used to blend the gradient in and out. A Blend amount of 0 will make this effect invisible
```

--------------------------------

### Changing Material Properties in Unity C#

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/scripting

This C# code snippet demonstrates how to access a Material component from a Renderer and programmatically set its properties such as float values (e.g., _Alpha), colors (e.g., _Color), and textures (e.g., _MainTex). It uses `Material.SetFloat`, `Material.SetColor`, and `Material.SetTexture` functions. A note is included about the distinction between `material` and `sharedMaterial` for instance-specific vs. global changes.

```C#
Material mat = GetComponent<Renderer>().material;
mat.SetFloat("_Alpha", 1f);
mat.SetColor("_Color", new Color(0.5f, 1f, 0f, 1f));
mat.SetTexture("_MainTex", texture);
```

--------------------------------

### Duplicate UI Material Instance on Awake

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/how-to-animate-materials

This C# code snippet demonstrates how to create a unique copy of a UI Graphic's material instance during the Awake method. This is crucial for UI elements because Unity UI Images always use shared material instances, preventing direct animation or modification of individual UI material properties via the Animator. Duplicating the material ensures that changes to one UI element's material do not affect others sharing the original material.

```C#
private void Awake()
{
        Graphic graphic = GetComponent<Graphic>();
        graphic.material = new Material(graphic.material);
}
```

--------------------------------

### Hand Drawn (DOODLE_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Applies a frame-by-frame distortion to textures, creating a hand-drawn appearance. The amount and frequency of distortion can be configured.

```APIDOC
Hand Drawn (DOODLE_ON):
  _HandDrawnAmount: Controls the intensity of the hand-drawn distortion applied frame by frame.
  _HandDrawnSpeed: Determines the frequency at which textures are distorted.
```

--------------------------------

### Enable/Disable Shader Keywords in C#

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/how-to-enable-disable-effects-at-runtime

This C# code snippet demonstrates how to enable or disable specific shader compilation flags (keywords) on a material at runtime. This method requires that the corresponding shader variants are already compiled and available in the final build to prevent rendering errors. Keyword names can be found in the 'Effects and Properties Breakdown' section or by hovering over effects in the Material Inspector.

```C#
Material mat = GetComponent<Renderer>().material;
…
mat.EnableKeyword("GLOW_ON");
mat.DisableKeyword("GLOW_ON");
```

--------------------------------

### Texture Fade Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

General properties for controlling texture-based fading effects, including transparency, texture mapping, and burn effects.

```APIDOC
Fade Amount Affects Global Transparency (ALPHAFADETRANSPARENCYTOO_ON): Toggle Box - When checked the global transparency will decrease with the Fade Amount
Fade Amount Driven By Vertex Stream? (ALPHAFADEINPUTSTREAM_ON): Toggle Box - When enabled the Fade Amount can be driven with Custom Data streams. Check the Custom Vertex Streams and Custom Data Auto Setup for more details
Fade Texture (_FadeTex): Maps how the fade will be made. The fade will be made from black to white
Fade Amount (_FadeAmount): How much fade to apply. -0.1 is no fading and 1 is completely faded
Fade Transition (_FadeTransition): How smooth the dissolve edges are. The higher the number the smoother it will be
Fade Power (_FadePower): The exponent of the fade amount, used to tweak how soon/late the fade happens
Speed X/Y Axis (_FadeScrollXSpeed and _FadeScrollYSpeed): Scroll speed of the fade texture in the X axis and Y axis
Fade Burn Texture (_FadeBurnTex): Texture of the burned edge
Fade Burn Color (_FadeBurnColor): Color of the burned edges, has HDR and can also affect how bright the material shines by increasing the HDR intensity
Fade Burn Width (_FadeBurnWidth): How smooth the burn edges are. The higher the number the smoother it will be
Fade Burn Glow (_FadeBurnGlow): Indicates how bright the texture will shine (needs Bloom in the scene)
```

--------------------------------

### Trail Width (TRAILWIDTH_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Offers precise control over the vertical texture coordinate scale, enabling trail scaling without common Trail Renderer component artifacts. This feature requires the material to be 'Saved To Folder' and a consistent width in the Trail Renderer component.

```APIDOC
Trail Width (TRAILWIDTH_ON):
  _TrailWidthPower: The exponent for the trail width, allowing fine-tuning of results without directly editing the gradient.
  _TrailWidthGradient: A custom gradient property editable with the Unity gradient window. Black corresponds to 0 scale (0 width), and white corresponds to 1 scale (maximum width).
```

--------------------------------

### VFX Toolkit: Vertex Offset Parameters

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Parameters for displacing mesh vertices using a noise texture. These controls define the texture used for offset, the maximum displacement distance, the power curve for fine-tuning, and the scroll speed of the offset texture.

```APIDOC
Vertex Offset [VERTOFFSET_ON]: Displaces the vertices of the mesh
  Offset Noise Texture (_VertOffsetTex): Tells the shader how to offset the vertices. 1 means maximum offset, 0 means no offset
  Offset Amount (_VertOffsetAmount): The offset amount, this will set the max offset distance
  Offset Power (_VertOffsetPower): Exponent of the offset amount used to fine tune the effect
  Scroll Speed X/Y (_VertOffsetTexXSpeed and _VertOffsetTexYSpeed): How fast the Offset Noise Texture will scroll on the X and Y axis
```

--------------------------------

### Fake Light and Shadow Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

This isn’t real lighting that will work with Unity lighting components, instead this is a simplified performant lighting approximation that can be used to give some more depth to your effects. For this to work you’ll need to have an active AllIn1VfxFakeLightDirSetter component in the scene, this component will tell the shader what the direction of the light is. Configure said component to choose when the light direction is updated and to choose the target transform that will determine the light direction with its forward vector.

```APIDOC
Light Amount (_LightAmount):
  Description: This is how much extra luminosity we want.
  Values:
    0: No extra luminosity.
    1: Light the object based on the direction of the target light set in AllIn1VfxFakeLightDirSetter.
Light Color (_LightColor):
  Description: The color of the fake light, use this to choose the tint of the light set by the previous property. Note that this is an HDR color and that can be used to make the object glow by increasing the intensity.
Shadow Amount (_ShadowAmount):
  Description: This tells the shader what is the darkest shadow value.
  Values:
    0: Shadows can be completely black.
    1: Shadows won’t be visible at all.
Shadow Min and Max (_ShadowStepMin and _ShadowStepMax):
  Description: This is used to choose the banding on the shadow, the closer these values are together the more cartoon the shadow will look.
```

--------------------------------

### Twist (TWISTUV_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Applies a twisting distortion to all textures. This effect can be customized by adjusting the twist amount, position of the twist center, and its radius.

```APIDOC
Twist (TWISTUV_ON):
  _TwistUvAmount: Controls the intensity of the texture twist.
  _TwistUvPosX: X-axis position of the twist center (0 is left, 1 is right).
  _TwistUvPosY: Y-axis position of the twist center (0 is bottom, 1 is top).
  _TwistUvRadius: The radius of the twist effect.
```

--------------------------------

### Alpha Cutoff [ALPHACUTOFF_ON]

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Describes the property for discarding pixels based on their transparency to reduce overdraw.

```APIDOC
Alpha cutoff value (_AlphaCutoffValue): Pixels that are more transparent than this value are not drawn. This is useful to make more cartoon looking effects and to discard unwanted transparencies from certain effects
```

--------------------------------

### Fresnel / Rim Color Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Details properties for creating a rim light or Fresnel effect around a mesh, allowing for color addition or transparency.

```APIDOC
Fresnel / Rim Color:
  Description: Creates a rim light / fresnel effect around the target Mesh. This effect can add color or make the Mesh transparent around the rims
  Properties:
    Rim Color (_RimColor):
      Description: Color of the effect, has HDR and can also affect how bright the material shines by increasing the HDR intensity
    Rim Bias (_RimBias):
      Description: Adds this amount to the “amount of rim” the shader detects and therefore makes all parts of the mesh be considered part of the rim (in most cases you’ll want to use the Rim Scale instead)
    Rim Scale (_RimScale):
      Description: Multiplies this amount to the “amount of rim” the shader detects and therefore makes the rim wider
    Rim Power (_RimPower):
      Description: Exponent of the “amount of rim” the shader detects and therefore can be used to further fine tune the rim width
    Rim Intensity (_RimIntensity):
      Description: Indicates how bright the Rim Color will shine
```

--------------------------------

### Texture Offset Custom Stream (OFFSETSTREAM_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Allows for scrolling or offsetting individual shape textures using data from a Particle System Custom Data stream. This effect is only visible when applied to an object with an active Particle System or if it's already enabled.

```APIDOC
Texture Offset Custom Stream (OFFSETSTREAM_ON):
  _OffsetShN: Multiplier for the offset value from the vertex stream. This enables affecting each shape differently with a single vertex stream value, controlling their scroll direction and magnitude.
```

--------------------------------

### VFX Toolkit: Shake Speed Parameters

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Parameters controlling the shake effect's speed and directional intensity within the VFX toolkit. These values determine how fast the effect oscillates and its displacement along the X and Y axes.

```APIDOC
Shake Speed (_ShakeUvSpeed): How fast it shakes
Shake X Multiplier (_ShakeUvX): The higher the value the more it will move on the X axis while shaking
Shake Y Multiplier (_ShakeUvY): The higher the value the more it will move on the Y axis while shaking
```

--------------------------------

### Soft Particles / Intersection Fade [SOFTPART_ON]

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Details properties for fading global results when close to other meshes that write to the depth buffer, useful for ground intersections.

```APIDOC
Soft Particles Factor (_SoftFactor): The higher this value is the thinner the fade transition will be
```

--------------------------------

### Fade From Final Shape (Procedural Dissolve) [ALPHAFADE_ON]

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Describes properties for a procedural dissolve effect that uses the final shape as a fade mask instead of a texture.

```APIDOC
Fade Amount Affects Global Transparency (ALPHAFADETRANSPARENCYTOO_ON): Toggle Box - When checked the global transparency will decrease with the Fade Amount
Fade Amount Driven By Vertex Stream? (ALPHAFADEINPUTSTREAM_ON): Toggle Box - When enabled the Fade Amount can be driven with Custom Data streams. Check the Custom Vertex Streams and Custom Data Auto Setup for more details
Use grayscale as alpha (ALPHAFADEUSEREDCHANNEL_ON): Enable this on additive configurations or when the shape result has no alpha. This will premultiply the red channel of the shape result into the alpha channels giving better results on the described cases
Use Shape1 as fade mask (ALPHAFADEUSESHAPE1_ON): When checked the shader will take Shape1 as fade mask input instead of using the combined shape result (only useful when using more than 1 shape)
Fade Amount (_AlphaFadeAmount): How much fade to apply. -0.1 is no fading and 1 is completely faded
Fade Transition (_AlphaFadeSmooth): How smooth the dissolve edges are. The higher the number the smoother it will be
Fade Power (_AlphaFadePow): The exponent of the fade amount, used to tweak how soon/late the fade happens
```

--------------------------------

### Shape Weights Custom Stream (SHAPEWEIGHTS_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Enables the modification of individual shape weights through a Particle System Custom Data stream. This effect is visible only when an object has an active Particle System or if the effect is already enabled, typically configured in the Material's Shape Result tab.

```APIDOC
Shape Weights Custom Stream (SHAPEWEIGHTS_ON):
  _ShNBlendOffset: Multiplier for the offset value received from the vertex stream, allowing control over the direction and magnitude of the offset for each Shape N.
```

--------------------------------

### Global Texture Scroll (TEXTURESCROLL_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Applies a universal scrolling effect to all textures utilized by the shader, providing a consistent motion across the material.

```APIDOC
Global Texture Scroll (TEXTURESCROLL_ON):
  _TextureScrollXSpeed: Scrolling speed on the X axis.
  _TextureScrollYSpeed: Scrolling speed on the Y axis.
```

--------------------------------

### Round Wave (ROUNDWAVEUV_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Applies radial distortion waves to textures. This effect can be adjusted for strength and scrolling speed.

```APIDOC
Round Wave (ROUNDWAVEUV_ON):
  _RoundWaveStrength: Controls the intensity of the radial wave effect on textures.
  _RoundWaveSpeed: Controls the scrolling speed of the radial waves.
```

--------------------------------

### Shape Texture Offset (SHAPETEXOFFSET_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Helps reduce visual repetition on objects that share the same material. It utilizes the Random Time Seed (_TimingSeed) to apply unique offsets to individual shape textures.

```APIDOC
Shape Texture Offset (SHAPETEXOFFSET_ON):
  _RandomShNMult: Controls the extent to which the Timing Seed offsets each Shape. A value of 0 means no variation, while 1 fully uses the Timing Seed but may result in perfect texture coordinate loops. Values between 0 and 1 are recommended for optimal results.
```

--------------------------------

### Global Polar Coordinates (POLARUV_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Transforms UV coordinates into polar coordinates. This effect is particularly effective when combined with tiling textures and texture scrolling for unique visual patterns.

```APIDOC
Global Polar Coordinates (POLARUV_ON):
  Polar Coords affects Distortion textures (POLARUVDISTORT_ON): Toggle to apply polar coordinate transformation to distortion textures.
```

--------------------------------

### Fade From Noise Texture (Dissolve) Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Uses a Fade Texture to fade/dissolve the global result. Particle system alpha or Custom Data Streams can be used to control this dissolve. A burn texture can be added to have a different color around dissolve edges. This effect applies color changes to the shape combination alpha result.

```APIDOC
Fade From Noise Texture (Dissolve) [FADE_ON]:
  Description: Uses a Fade Texture to fade/dissolve the global result. Particle system alpha or Custom Data Streams can be used to control this dissolve. A burn texture can be added to have a different color around dissolve edges.
```

--------------------------------

### Pixelate (PIXELATE_ON)

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Applies a pixelation effect to textures. Note that this effect may not combine well with other distortions.

```APIDOC
Pixelate (PIXELATE_ON):
  _PixelateSize: Controls the size of the pixels; lower values result in more pixelated textures. This effect looks bad when combined with distortions.
```

--------------------------------

### Intersection Glow Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Applies glow to intersecting geometry that writes to the depth buffer. Needs Post Processing Bloom for better visuals. For this effect to work as intended ZWrite should be disabled.

```APIDOC
Depth Distance (_DepthGlowDist):
  Description: How sensible the depth difference is. The higher the value the sharper the glow will be.
Depth Power (_DepthGlowPow):
  Description: Exponent of the depth difference that creates the glow mask.
Glow Color (_DepthGlowColor):
  Description: Color of the Glow, has HDR and can also affect how bright the material shines by increasing the HDR intensity.
Glow Color Intensity (_DepthGlow):
  Description: Indicates how bright the Glow Color will shine.
Global Glow Intensity (_DepthGlowGlobal):
  Description: Indicates how bright the global result will shine (needs Bloom in the scene).
```

--------------------------------

### Backface Tint Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Tints the front and back face of the target mesh. The backface is considered the face that has the normal vector pointing in the opposite direction of what we would regularly expect on a surface.

```APIDOC
Backface Tint (_BackFaceTint):
  Description: Tint Color back face of the mesh. The color is HDR so can be used to affect color intensity and therefore glow.
FrontfaceTint (_FrontFaceTint):
  Description: Tint Color front face of the mesh. The color is HDR so can be used to affect color intensity and therefore glow. Usually we’ll keep this white to not affect regular facing mesh faces.
```

--------------------------------

### Distortion Scroll Speed

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Controls the scroll speed of the distortion texture along the X and Y axes, allowing for dynamic distortion effects.

```APIDOC
Distortion scroll speed:
  _DistortTexXSpeed: Scroll speed of the distortion texture in the X axis
  _DistortTexYSpeed: Scroll speed of the distortion texture in the Y axis
```

--------------------------------

### Alpha Mask Effect Properties

Source: https://seasidestudios.gitbook.io/seaside-studios/vfx-toolkit/credits/vfx-toolkit/effects-and-properties-breakdown

Will make certain parts of the global result transparent. This effect applies color changes to the shape combination alpha result.

```APIDOC
Mask Texture (_MaskTex):
  Description: White on the texture means unaltered original opacity. Black means fully invisible.
Mask Power (_MaskPow):
  Description: Exponent of the Mask Texture, used to fine tune the effect without doing any change to the Mask Texture.
```
Tokens:
Raw