🖼️ PostProcess

Interaction with Post Process effects.

🗿Static ClassClient Only🧑‍💻API Source

---

🗿 Static Functions

	Returns	Name	Description
		RemoveMaterial	Removes the current Post Process Material
		SetBloom	Set Post Process Bloom Settings
		SetChromaticAberration	Set Post Process Chromatic Aberration Settings
		SetExposure	Set Post Process Exposure Settings
		SetFilm	Set Post Process Film Settings
		SetGlobalContrast	Set Post Process Global Contrast
		SetGlobalGain	Set Post Process Global Gain
		SetGlobalGamma	Set Post Process Global Gamma
		SetGlobalOffset	Set Post Process Global Offset
		SetGlobalSaturation	Set Post Process Saturation Colors. Use Alpha for overall Saturation intensity
		SetImageEffects	Set Post Process Image Effect Settings
		SetLookupTable	Set Post Process Lookup Table (LUT) Texture
		SetMaterial	Sets a Post Process Material

---

Optimal

RemoveMaterial

Removes the current Post Process Material

PostProcess.RemoveMaterial()

---

Optimal

SetBloom

Set Post Process Bloom Settings

PostProcess.SetBloom(intensity?, threshold?)

Parameters

Type	Parameter	Default	Description
float	intensity?	0.675	Bloom intensity
float	threshold?	-1	Minimum brightness for a pixel to bloom

---

Optimal

SetChromaticAberration

Set Post Process Chromatic Aberration Settings

PostProcess.SetChromaticAberration(intensity?, start_offset?)

Parameters

Type	Parameter	Default	Description
float	intensity?	0	Chromatic aberration intensity
float	start_offset?	0	Distance from the screen center where it starts (0 to 1)

---

Optimal

SetExposure

Set Post Process Exposure Settings

PostProcess.SetExposure(exposure_compensation?, min_ev100?, max_ev100?, low_percent?, high_percent?)

Parameters

Type	Parameter	Default	Description
float	exposure_compensation?	1	Exposure bias, in EV
float	min_ev100?	-10	Min auto exposure brightness, in EV100
float	max_ev100?	20	Max auto exposure brightness, in EV100
float	low_percent?	10	Histogram low percentage used by auto exposure
float	high_percent?	90	Histogram high percentage used by auto exposure

---

Optimal

SetFilm

Set Post Process Film Settings

PostProcess.SetFilm(slope?, toe?, shoulder?, black_clip?, white_clip?)

Parameters

Type	Parameter	Default	Description
float	slope?	0.8	Steepness of the tonemapper S-curve
float	toe?	0.55	Adjusts the dark tones
float	shoulder?	0.26	Adjusts the bright tones
float	black_clip?	0	Where the dark tones clip
float	white_clip?	0.3	Where the bright tones clip

---

Optimal

SetGlobalContrast

Set Post Process Global Contrast

PostProcess.SetGlobalContrast(contrast)

Parameters

Type	Parameter	Default	Description
Color	contrast	Required parameter	The new Post Process Global Contrast

---

Optimal

SetGlobalGain

Set Post Process Global Gain

PostProcess.SetGlobalGain(gain)

Parameters

Type	Parameter	Default	Description
Color	gain	Required parameter	The new Post Process Global Gain

---

Optimal

SetGlobalGamma

Set Post Process Global Gamma

PostProcess.SetGlobalGamma(gamma)

Parameters

Type	Parameter	Default	Description
Color	gamma	Required parameter	The new Post Process Global Gamma

---

Optimal

SetGlobalOffset

Set Post Process Global Offset

PostProcess.SetGlobalOffset(offset)

Parameters

Type	Parameter	Default	Description
Color	offset	Required parameter	The new Post Process Global Offset

---

Optimal

SetGlobalSaturation

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

PostProcess.SetGlobalSaturation(color)

Parameters

Type	Parameter	Default	Description
Color	color	Required parameter	The new Post Process Saturation Colors. Use Alpha for overall Saturation intensity

---

Optimal

SetImageEffects

Set Post Process Image Effect Settings

PostProcess.SetImageEffects(vignette_intensity?, film_grain_intensity?)

Parameters

Type	Parameter	Default	Description
float	vignette_intensity?	0.6	Darkening of the screen edges
float	film_grain_intensity?	0	Amount of film grain noise

---

Slow

SetLookupTable

Set Post Process Lookup Table (LUT) Texture

PostProcess.SetLookupTable(texture_path)

Parameters

Type	Parameter	Default	Description
Image Path	texture_path	Required parameter	The new Post Process Lookup Table (LUT) Texture

---

Slow

SetMaterial

Sets a Post Process Material

PostProcess.SetMaterial(material_path)

Parameters

Type	Parameter	Default	Description
Material Reference	material_path	Required parameter	The Material Asset to set as Post Process

🚀 Events

This class doesn't have own events.