Skip to main content
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
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 Aberration Settings
SetExposureSet Post Process Exposure Settings
SetFilmSet Post Process Film Settings
SetGlobalContrastSet Post Process Global Contrast
SetGlobalGainSet Post Process Global Gain
SetGlobalGammaSet Post Process Global Gamma
SetGlobalOffsetSet Post Process Global Offset
SetGlobalSaturationSet Post Process Saturation Colors. Use Alpha for overall Saturation intensity
SetImageEffectsSet Post Process Image Effect Settings
SetLookupTableSet Post Process Lookup Table (LUT) Texture
SetMaterialSets a Post Process Material

RemoveMaterialโ€‹

Removes the current Post Process Material
PostProcess.RemoveMaterial()

SetBloomโ€‹

Set Post Process Bloom Settings
PostProcess.SetBloom(intensity?, threshold?)

Parameters

TypeParameterDefaultDescription
floatintensity?0.675No description provided
floatthreshold?-1No description provided

SetChromaticAberrationโ€‹

Set Post Process Chromatic Aberration Settings
PostProcess.SetChromaticAberration(intensity?, start_offset?)

Parameters

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?)

Parameters

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?)

Parameters

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

SetGlobalContrastโ€‹

Set Post Process Global Contrast
PostProcess.SetGlobalContrast(contrast)

Parameters

TypeParameterDefaultDescription
Colorcontrast Required parameter No description provided

SetGlobalGainโ€‹

Set Post Process Global Gain
PostProcess.SetGlobalGain(gain)

Parameters

TypeParameterDefaultDescription
Colorgain Required parameter No description provided

SetGlobalGammaโ€‹

Set Post Process Global Gamma
PostProcess.SetGlobalGamma(gamma)

Parameters

TypeParameterDefaultDescription
Colorgamma Required parameter No description provided

SetGlobalOffsetโ€‹

Set Post Process Global Offset
PostProcess.SetGlobalOffset(offset)

Parameters

TypeParameterDefaultDescription
Coloroffset Required parameter No description provided

SetGlobalSaturationโ€‹

Set Post Process Saturation Colors. Use Alpha for overall Saturation intensity
PostProcess.SetGlobalSaturation(color)

Parameters

TypeParameterDefaultDescription
Colorcolor Required parameter No description provided

SetImageEffectsโ€‹

Set Post Process Image Effect Settings
PostProcess.SetImageEffects(vignette_intensity?, film_grain_intensity?)

Parameters

TypeParameterDefaultDescription
floatvignette_intensity?0.6No description provided
floatfilm_grain_intensity?0No description provided

SetLookupTableโ€‹

Set Post Process Lookup Table (LUT) Texture
PostProcess.SetLookupTable(texture_path)

Parameters

TypeParameterDefaultDescription
Image Pathtexture_path Required parameter No description provided

SetMaterialโ€‹

Sets a Post Process Material
PostProcess.SetMaterial(material_path)

Parameters

TypeParameterDefaultDescription
Material Referencematerial_path Required parameter The Material Asset to set as Post Process

๐Ÿš€ย Eventsโ€‹

This class doesn't have own events.