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

SetChromaticAberration

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

Parameters

TypeParameterDefaultDescription
floatintensity?0
No description provided
floatstart_offset?0
No description provided

SetExposure

Set Post Process Exposure Settings
PostProcess.SetExposure(exposure_compensation?, min_ev100?, max_ev100?, low_percent?, high_percent?)

Parameters

TypeParameterDefaultDescription
floatexposure_compensation?1
No description provided
floatmin_ev100?-10
No description provided
floatmax_ev100?20
No description provided
floatlow_percent?10
No description provided
floathigh_percent?90
No description provided

SetFilm

Set Post Process Film Settings
PostProcess.SetFilm(slope?, toe?, shoulder?, black_clip?, white_clip?)

Parameters

TypeParameterDefaultDescription
floatslope?0.8
No description provided
floattoe?0.55
No description provided
floatshoulder?0.26
No description provided
floatblack_clip?0
No description provided
floatwhite_clip?0.3
No 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.6
No description provided
floatfilm_grain_intensity?0
No 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.