Skip to main content
Version: latest - a1.64.x ⚖️

🖼️ 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​

ReturnsNameDescription
RemoveMaterialRemoves the current Post Process Material
SetBloomSet Post Process Bloom Settings
SetChromaticAberrationSet Post Process Chromatic Abberation Settings
SetExposureSet Post Process Exposure Settings
SetFilmSet Post Process Film Settings
SetGlobalSaturationSet Post Process Saturation Colors. Use Alpha for everall Saturation intensity
SetImageEffectsSet Post Process Image Effect Settings
SetLookupTableSet Post Process Lookup Table Texture
SetMaterialSets a Post Process Material
SetSunAngleSets 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?)
TypeParameterDefaultDescription
floatintensity?0.675No description provided
floatthreshold?-1No description provided

SetChromaticAberration

Set Post Process Chromatic Abberation Settings

PostProcess.SetChromaticAberration(intensity?, start_offset?)
TypeParameterDefaultDescription
floatintensity?0No description provided
floatstart_offset?0No description provided

SetExposure

Set Post Process Exposure Settings

PostProcess.SetExposure(exposure_compensation?, min_ev100?, max_ev100?, low_percent?, high_percent?)
TypeParameterDefaultDescription
floatexposure_compensation?1No description provided
floatmin_ev100?-10No description provided
floatmax_ev100?20No description provided
floatlow_percent?10No description provided
floathigh_percent?90No description provided

SetFilm

Set Post Process Film Settings

PostProcess.SetFilm(slope?, toe?, shoulder?, black_clip?, white_clip?)
TypeParameterDefaultDescription
floatslope?0.8No description provided
floattoe?0.55No description provided
floatshoulder?0.26No description provided
floatblack_clip?0No description provided
floatwhite_clip?0.3No description provided

SetGlobalSaturation

Set Post Process Saturation Colors. Use Alpha for everall Saturation intensity

PostProcess.SetGlobalSaturation(color)
TypeParameterDefaultDescription
Colorcolor Required parameter No description provided

SetImageEffects

Set Post Process Image Effect Settings

PostProcess.SetImageEffects(vignette_intensity?, grain_jitter?, grain_intensity?)
TypeParameterDefaultDescription
floatvignette_intensity?0.6No description provided
floatgrain_jitter?0No description provided
floatgrain_intensity?0No description provided

SetLookupTable

Set Post Process Lookup Table Texture

PostProcess.SetLookupTable(texture_path)
TypeParameterDefaultDescription
Image Pathtexture_path Required parameter No description provided

SetMaterial

Sets a Post Process Material

PostProcess.SetMaterial(material_path)
TypeParameterDefaultDescription
Material Referencematerial_path Required parameter The Material Asset to set as Post Process

SetSunAngle

Sets the sun's angle (0-360)

PostProcess.SetSunAngle(angle)
TypeParameterDefaultDescription
floatangle Required parameter No description provided

🚀 Events​

This class doesn't have own events.