CelShaderFX - API Reference

Scripting Documentation



Namespaces

using CelShaderFX;              // Core types, settings, presets
using CelShaderFX.BuiltIn;      // Built-In pipeline components
using CelShaderFX.URP;          // URP pipeline components
using CelShaderFX.HDRP;         // HDRP pipeline components
using CelShaderFX.Advanced;     // Modular controller
using CelShaderFX.Modules;      // Individual effect modules

Core Classes

CelShaderSettings

ScriptableObject containing all effect parameters.

Namespace: CelShaderFX

File: Runtime/Scripts/Core/CelShaderSettings.cs

Creating an Instance

// Via Unity Editor
// Right-click > Create > CelShaderFX > Settings

// Via Script
var settings = ScriptableObject.CreateInstance<CelShaderSettings>();

Properties - Cel Shading

Property Type Description
enableCelShading bool Enable cel shading effect
celBandCount int Number of color bands (2-16)
celSoftness float Band transition softness (0-1)
celSaturation float Color saturation (0-2)
useRampTexture bool Use custom gradient texture
rampTexture Texture2D Custom shading ramp
useColorPalette bool Enable palette quantization
paletteColor1-4 Color Palette colors
paletteSoftness float Palette blending

Properties - Outline

Property Type Description
enableOutline bool Enable outline effect
outlineMethod OutlineMethod Detection algorithm
outlineThickness float Line width (0.5-5)
outlineColor Color Line color
outlineDepthThreshold float Depth sensitivity
outlineNormalThreshold float Normal sensitivity
outlineDepthWeight float Depth edge weight
outlineNormalWeight float Normal edge weight
outlineCurvatureWeight float Curvature edge weight
outlineDistanceFade float Distance fade amount

Properties - Kuwahara