Flat Kit

https://flatkit.dustyroom.com
Admin
Flat Kit is a comprehensive set of stylized shaders and image effects for Unity that enables fast...
Tokens:10,500
Snippets:182
Trust Score:8.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Flat Kit Pixelation Setup and Parameters

Source: https://flatkit.dustyroom.com/pixelation

This section details how to add the Flat Kit Pixelation effect to your Renderer and explains its configurable parameters.

```APIDOC
## Flat Kit Pixelation Setup

### Description
Adds the Flat Kit Pixelation effect as a Renderer Feature in Unity's Universal Render Pipeline (URP).

### Method
Add Renderer Feature

### Endpoint
N/A (Unity Editor specific)

### Parameters
#### Renderer Feature
- **Flat Kit Pixelation** (Renderer Feature) - Required - Select this option from the list to add the effect.

## Flat Kit Pixelation Parameters

### Description
Configurable settings for the Flat Kit Pixelation effect.

### Method
N/A (Inspector settings)

### Endpoint
N/A (Inspector settings)

### Parameters
#### Inspector Parameters
- **Resolution** (float) - Controls the size of the pixels. Higher values result in smaller pixels.
- **Render Event** (enum) - Specifies the stage at which the Pixelation effect is applied. Some effects may require pressing 'Play' to be visible.
- **Apply In Scene View** (bool) - Determines if the effect should be applied in the Scene view in addition to the Game view.
```

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

### Enable DOTS Instancing in StylizedSurface Shader

Source: https://flatkit.dustyroom.com/stylized-surface

To enable DOTS instancing, uncomment the specified line in the StylizedSurface shader file.

```csharp
#define FLAT_KIT_DOTS_INSTANCING_ON
```

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

### Stylized Surface with Outline Shader

Source: https://flatkit.dustyroom.com/stylized-surface

Details on the Stylized Surface with Outline shader, its deprecation in URP, and its parameters.

```APIDOC
## Stylized Surface with Outline Shader

**NOTE:** _Stylized Surface with Outline_ shader has been deprecated in Universal RP version of Flat Kit: the outline functionality has been moved to the Outline parameters of _Stylized Surface_ shader. _Stylized Surface with Outline_ remains available and working for the sake of compatibility with existing projects, but it is advised to use _Stylized Surface_ for the new projects instead. _Stylized Surface with Outline_ has not been deprecated in Built-In LTS version of Flat Kit.

You can use _Stylized Surface_ shader to outline a particular object. It is a parameter (shader pass) that is built on top of the _Stylized Surface_ shader. It has all the features of the _Stylized Surface_ shader plus the outline feature.

‘Stylized Surface with Outline’ shader

* **Color** picks up the color of the outline.
* **Width** determines how thick the outline is.
* **Scale** adjust this parameter when you have gaps on the vertices (please note, this is not an ultimate solution, the gaps need a complex approach — in modelling, adjusting the normals, adjusting camera distance etc. More about the gaps issue can be found a bit below).
* **Depth Offset** moves the outline inwards or outwards an object.
* **Camera Distance Impact** **(this parameter is available in Universal RP only)** makes outlines that are further from camera appear thinner than outlines closer to the camera.
```

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

### Stylized Surface Cutout Shader

Source: https://flatkit.dustyroom.com/stylized-surface

Information about the Stylized Surface Cutout shader, its deprecation in URP, and its usage in Built-In RP.

```APIDOC
## Stylized Surface Cutout Shader

**NOTE:** ‘ _Stylized Surface Cutout_ ’ shader has been deprecated in Flat Kit 2.1.2 for Universal RP version (‘ _Stylized Surface Cutout_ ’ is still available in Built-In RP version). Because URP supports transparency by default, there’s no need for this separate shader in URP. The _Stylized Surface_ and _Stylized Surface with Outline_ shaders can do everything _Stylized Surface Cutout_ could — using _Rendering options_ part of the shaders in the bottom of the interface. There you can find an option to set the shading in transparency mode (_Surface Type_ drop down menu ▶︎ _Transparent_. The default type is _Opaque_).

This is a version of _Stylized Surface_ shader with an option to treat alpha as transparency on a texture. The rest of the shader is the same.

The _Base Alpha cutout_ parameter determines how much of the alpha portion of the texture is going to be transparent.

‘Stylized Surface Cutout’ shader — Valley demo scene, tree branches material. Inspector interface

Use this shader if you work with transparency in Built-In RP. In URP you are good to go with the _Stylized Surface_ shader instead of this one. It will spare a few cycles from your CPU.
```

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

### Material Properties for Script Manipulation

Source: https://flatkit.dustyroom.com/stylized-surface

This section lists the color field names that can be manipulated via code for effects like tweening and randomization.

```APIDOC
## Setting material values from scripts

The following are the color field names for manipulation via the code for tweening, randomization etc:

* `_BaseColor` (in URP), `_Color` (in Built-in RP): the primary color, “Color” in the inspector. The alpha value controls transparency of the object if `Surface Type` is set to `Transparent`
* `_ColorDim` (and `_ColorDimSteps`, `_ColorDimCurve` in the corresponding cel shading modes): Color Shaded in the Inspector
* `_ColorDimExtra`: the shaded color of the _“Extra Cel Layer”_ feature
* `_FlatRimColor`: rim color, requires _“Enable Rim Color”_
* `_FlatSpecularColor`: specular color, requires _“Enable Specular Color”_
* `_ColorGradient`: the gradient color used along with the `_BaseColor` parameter when _“Enable Height Color”_ feature is active

The full list of parameters is at the top of the file `Assets/FlatKit/Shaders/StylizedSurface/StylizedSurface.shader`.

**NOTE.** The outline toggle is implemented as a shader keyword, so unfortunately it can’t be toggled at runtime. However, you can enable the outline in the material inspector and toggle its visibility in code by setting the outline width (0 will visually disable the outline). Or, you can create two identical materials with the only difference being the outline toggle, and switch between these materials at runtime with `renderer.material = myMaterial`.
```

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

### Dissolve Effect Parameters in Stylized Surface Shader

Source: https://flatkit.dustyroom.com/stylized-surface

This describes the parameters used for a dissolve effect in the Stylized Surface shader. Adjust the Threshold parameter to control the visibility of transparent pixels.

```shaderlab
Shader "Flat Kit/Stylized Surface" {
    Properties {
        _Color ("Color", Color) = (1,1,1,1)
        _Impact ("Impact", Range(0, 1)) = 0
        _Threshold ("Threshold", Range(0, 1)) = 0.5
        _DissolveTex ("Dissolve Texture", 2D) = "white" {}
        // ... other properties
    }
    // ... other shader code
}
```
Tokens:
Raw