🖼️ PostProcess
Interaction with Post Process effects.
🗿Static Class
This is a Static Class. Access it's methods directly with
.. It's not possible to spawn new instances.💂Authority
This static class can be accessed only on 🟧 Client side.
🧑💻API Source
The methods, properties and events descriptions from this page are defined in our GitHub API Repository!
🗿 Static Functions
| Returns | Name | Description | |
|---|---|---|---|
 | RemoveMaterial | Removes the current Post Process Material | |
| SetBloom | Set Post Process Bloom Settings | |
| SetChromaticAberration | Set Post Process Chromatic Abberation Settings | |
| SetExposure | Set Post Process Exposure Settings | |
| SetFilm | Set Post Process Film Settings | |
| SetGlobalSaturation | Set Post Process Saturation Colors. Use Alpha for everall Saturation intensity | |
| SetImageEffects | Set Post Process Image Effect Settings | |
| SetLookupTable | Set Post Process Lookup Table Texture | |
| SetMaterial | Sets a Post Process Material | |
| SetSunAngle | Sets the sun's angle (0-360) |
RemoveMaterial
Removes the current Post Process Material
PostProcess.RemoveMaterial()
SetBloom
Set Post Process Bloom Settings
PostProcess.SetBloom(intensity?, threshold?)
SetChromaticAberration
Set Post Process Chromatic Abberation Settings
PostProcess.SetChromaticAberration(intensity?, start_offset?)
SetExposure
Set Post Process Exposure Settings
PostProcess.SetExposure(exposure_compensation?, min_ev100?, max_ev100?, low_percent?, high_percent?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | exposure_compensation? | 1 | |
| float | min_ev100? | -10 | |
| float | max_ev100? | 20 | |
| float | low_percent? | 10 | |
| float | high_percent? | 90 |
SetFilm
Set Post Process Film Settings
PostProcess.SetFilm(slope?, toe?, shoulder?, black_clip?, white_clip?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | slope? | 0.8 | |
| float | toe? | 0.55 | |
| float | shoulder? | 0.26 | |
| float | black_clip? | 0 | |
| float | white_clip? | 0.3 |
SetGlobalSaturation
Set Post Process Saturation Colors. Use Alpha for everall Saturation intensity
PostProcess.SetGlobalSaturation(color)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Color | color |
SetImageEffects
Set Post Process Image Effect Settings
PostProcess.SetImageEffects(vignette_intensity?, grain_jitter?, grain_intensity?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | vignette_intensity? | 0.6 | |
| float | grain_jitter? | 0 | |
| float | grain_intensity? | 0 |
SetLookupTable
Set Post Process Lookup Table Texture
PostProcess.SetLookupTable(texture_path)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Image Path | texture_path |
SetMaterial
Sets a Post Process Material
PostProcess.SetMaterial(material_path)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Material Reference | material_path | The Material Asset to set as Post Process |
SetSunAngle
Sets the sun's angle (0-360)
PostProcess.SetSunAngle(angle)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | angle |