🖼️ 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
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
🗿 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 | |
| SetGlobalContrast | Set Post Process Global Contrast | |
| SetGlobalGain | Set Post Process Global Gain | |
| SetGlobalGamma | Set Post Process Global Gamma | |
| SetGlobalOffset | Set Post Process Global Offset | |
| SetGlobalSaturation | Set Post Process Saturation Colors. Use Alpha for overall Saturation intensity | |
| SetImageEffects | Set Post Process Image Effect Settings | |
| SetLookupTable | Set Post Process Lookup Table (LUT) Texture | |
| SetMaterial | Sets a Post Process Material |
RemoveMaterial
Removes the current Post Process Material
PostProcess.RemoveMaterial()
SetBloom
Set Post Process Bloom Settings
PostProcess.SetBloom(intensity?, threshold?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | intensity? | 0.675 | No description provided |
| float | threshold? | -1 | No description provided |
SetChromaticAberration
Set Post Process Chromatic Abberation Settings
PostProcess.SetChromaticAberration(intensity?, start_offset?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | intensity? | 0 | No description provided |
| float | start_offset? | 0 | No description provided |
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 | No description provided |
| float | min_ev100? | -10 | No description provided |
| float | max_ev100? | 20 | No description provided |
| float | low_percent? | 10 | No description provided |
| float | high_percent? | 90 | No description provided |
SetFilm
Set Post Process Film Settings
PostProcess.SetFilm(slope?, toe?, shoulder?, black_clip?, white_clip?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | slope? | 0.8 | No description provided |
| float | toe? | 0.55 | No description provided |
| float | shoulder? | 0.26 | No description provided |
| float | black_clip? | 0 | No description provided |
| float | white_clip? | 0.3 | No description provided |
SetGlobalContrast
Set Post Process Global Contrast
PostProcess.SetGlobalContrast(contrast)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Color | contrast | Required parameter | No description provided |
SetGlobalGain
Set Post Process Global Gain
PostProcess.SetGlobalGain(gain)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Color | gain | Required parameter | No description provided |
SetGlobalGamma
Set Post Process Global Gamma
PostProcess.SetGlobalGamma(gamma)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Color | gamma | Required parameter | No description provided |
SetGlobalOffset
Set Post Process Global Offset
PostProcess.SetGlobalOffset(offset)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Color | offset | Required parameter | No description provided |
SetGlobalSaturation
Set Post Process Saturation Colors. Use Alpha for overall Saturation intensity
PostProcess.SetGlobalSaturation(color)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Color | color | Required parameter | No description provided |
SetImageEffects
Set Post Process Image Effect Settings
PostProcess.SetImageEffects(vignette_intensity?, film_grain_intensity?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | vignette_intensity? | 0.6 | No description provided |
| float | film_grain_intensity? | 0 | No description provided |
SetLookupTable
Set Post Process Lookup Table (LUT) Texture
PostProcess.SetLookupTable(texture_path)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Image Path | texture_path | Required parameter | No description provided |
SetMaterial
Sets a Post Process Material
PostProcess.SetMaterial(material_path)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Material Reference | material_path | Required parameter | The Material Asset to set as Post Process |
🚀 Events
This class doesn't have own events.