Skip to main content
Version: latest - a1.73.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
Removes the current Post Process Material
Set Post Process Bloom Settings
Set Post Process Chromatic Abberation Settings
Set Post Process Exposure Settings
Set Post Process Film Settings
Set Post Process Saturation Colors. Use Alpha for overall Saturation intensity
Set Post Process Image Effect Settings
Set Post Process Lookup Table (LUT) Texture
Sets a Post Process Material
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?)
TypeParameterDefaultDescription
intensity?0.675No description provided
threshold?-1No description provided

SetChromaticAberration

Set Post Process Chromatic Abberation Settings

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

SetExposure

Set Post Process Exposure Settings

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

SetFilm

Set Post Process Film Settings

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

SetGlobalSaturation

Set Post Process Saturation Colors. Use Alpha for overall 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
vignette_intensity?0.6No description provided
grain_jitter?0No description provided
grain_intensity?0No description provided

SetLookupTable

Set Post Process Lookup Table (LUT) Texture

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

SetMaterial

Sets a Post Process Material

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

SetSunAngle

Sets the sun's angle (0-360)

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

๐Ÿš€ Eventsโ€‹

This class doesn't have own events.