Passer au contenu principal
Version: bleeding-edge 🩸

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

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.675
floatthreshold?-1

SetChromaticAberration

Set Post Process Chromatic Abberation Settings

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

SetExposure

Set Post Process Exposure Settings

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

SetFilm

Set Post Process Film Settings

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

SetGlobalSaturation

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

PostProcess.SetGlobalSaturation(color)
TypeParameterDefaultDescription
Colorcolor

SetImageEffects

Set Post Process Image Effect Settings

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

SetLookupTable

Set Post Process Lookup Table Texture

PostProcess.SetLookupTable(texture_path)
TypeParameterDefaultDescription
Image Pathtexture_path

SetMaterial

Sets a Post Process Material

PostProcess.SetMaterial(material_path)
TypeParameterDefaultDescription
Material Referencematerial_pathThe Material Asset to set as Post Process

SetSunAngle

Sets the sun's angle (0-360)

PostProcess.SetSunAngle(angle)
TypeParameterDefaultDescription
floatangle

🚀 Events

This class doesn't have own events.