SineSpace.Scripting.Components.SPostProcessVolume Class Reference

Inheritance diagram for SineSpace.Scripting.Components.SPostProcessVolume:

Properties
bool	Enabled [get, set]
	Enable or disable post effect volume. More...
bool	IsGlobal [get, set]
	Should this volume be applied to the whole scene? More...
float?	BlendDistance [get, set]
	The outer distance to start blending from. A value of 0 means no blending and the volume overrides will be applied immediately upon entry. More...
float??	Weight [get, set]
	The total weight of this volume in the scene. 0 means it won't do anything, 1 means full effect. More...
float	Priority [get, set]
	The volume priority in the stack. Higher number means higher priority. Negative values are supported. More...
Properties inherited from ScriptClassComponent< PostProcessVolume >
SGameObject	GameObject [get]
	Return the GameObject which component added. More...

Property Documentation

BlendDistance

float? SineSpace.Scripting.Components.SPostProcessVolume.BlendDistance

getset

The outer distance to start blending from. A value of 0 means no blending and the volume overrides will be applied immediately upon entry.

–get post process volume from main camera 
volume = Space.Scene.Find(“Main Camera”).PostProcessVolume
–disable IsGlobal.
volume.IsGlobal = false
–set blend distance to 50, and if the camera is near to the trigger post process layer bound to,
–It would take effect and blend this volume with blend distance.
volume.BlendDistance = 50

Enabled

bool SineSpace.Scripting.Components.SPostProcessVolume.Enabled

getset

Enable or disable post effect volume.

–get post process volume from main camera 
volume = Space.Scene.Find(“Main Camera”).PostProcessVolume
–disable post process volume, post process should be disabled.
volume.Enabled = false

IsGlobal

bool SineSpace.Scripting.Components.SPostProcessVolume.IsGlobal

getset

Should this volume be applied to the whole scene?

–get post process volume from main camera 
volume = Space.Scene.Find(“Main Camera”).PostProcessVolume
–disable IsGlobal, this post process volume and the layer was bound won’t take effect if 
–camera is not in the trigger post process volume bound to.
volume.IsGlobal = false

Priority

float SineSpace.Scripting.Components.SPostProcessVolume.Priority

getset

The volume priority in the stack. Higher number means higher priority. Negative values are supported.

–get post process volume from main camera 
volume = Space.Scene.Find(“Main Camera”).PostProcessVolume
–set priority to 2, if there are multiple post process volume, it would take effect.
volume.Priority = 2

Weight

float?? SineSpace.Scripting.Components.SPostProcessVolume.Weight

getset

The total weight of this volume in the scene. 0 means it won't do anything, 1 means full effect.

–get post process volume from main camera 
volume = Space.Scene.Find(“Main Camera”).PostProcessVolume
–set weight to 0.5, post effect should be weakened
volume.Weight = 0.5