Class PostFxVolume

A special type of volume that blends custom set of post process settings into the rendering.

System.Object
Object
SceneObject
Actor
BoxVolume
PostFxVolume
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[ActorContextMenu("New/Visuals/Lighting & PostFX/Post Fx Volume")]
[ActorToolbox("Visuals")]
[Unmanaged]
public class PostFxVolume : BoxVolume, ISerializable

Constructors

PostFxVolume()

Initializes a new instance of the PostFxVolume.

Declaration
public PostFxVolume()

Properties

AmbientOcclusion

The ambient occlusion effect settings.

Declaration
[EditorDisplay("Ambient Occlusion", null)]
[EditorOrder(100)]
[Unmanaged]
public AmbientOcclusionSettings AmbientOcclusion { get; set; }
Property Value
AmbientOcclusionSettings

AntiAliasing

The anti-aliasing effect settings.

Declaration
[EditorDisplay("Anti Aliasing", null)]
[EditorOrder(1100)]
[Unmanaged]
public AntiAliasingSettings AntiAliasing { get; set; }
Property Value
AntiAliasingSettings

BlendRadius

Gets or sets the distance inside the volume at which blending with the volume's settings occurs.

Declaration
[EditorDisplay("PostFx Volume", null)]
[EditorOrder(70)]
[Unmanaged]
public float BlendRadius { get; set; }
Property Value
System.Single

BlendWeight

Gets or sets the amount of influence the volume's properties have. 0 is no effect; 1 is full effect.

Declaration
[EditorDisplay("PostFx Volume", null)]
[EditorOrder(80)]
[Unmanaged]
public float BlendWeight { get; set; }
Property Value
System.Single

Bloom

The bloom effect settings.

Declaration
[EditorDisplay("Bloom", null)]
[EditorOrder(200)]
[Unmanaged]
public BloomSettings Bloom { get; set; }
Property Value
BloomSettings

CameraArtifacts

The camera artifacts effect settings.

Declaration
[EditorDisplay("Camera Artifacts", null)]
[EditorOrder(600)]
[Unmanaged]
public CameraArtifactsSettings CameraArtifacts { get; set; }
Property Value
CameraArtifactsSettings

ColorGrading

The color grading effect settings.

Declaration
[EditorDisplay("Color Grading", null)]
[EditorOrder(400)]
[Unmanaged]
public ColorGradingSettings ColorGrading { get; set; }
Property Value
ColorGradingSettings

DepthOfField

The depth of field effect settings.

Declaration
[EditorDisplay("Depth Of Field", null)]
[EditorOrder(800)]
[Unmanaged]
public DepthOfFieldSettings DepthOfField { get; set; }
Property Value
DepthOfFieldSettings

EyeAdaptation

The eye adaptation effect settings.

Declaration
[EditorDisplay("Eye Adaptation", null)]
[EditorOrder(500)]
[Unmanaged]
public EyeAdaptationSettings EyeAdaptation { get; set; }
Property Value
EyeAdaptationSettings

GlobalIllumination

The Global Illumination effect settings.

Declaration
[EditorDisplay("Global Illumination", null)]
[EditorOrder(150)]
[Unmanaged]
public GlobalIlluminationSettings GlobalIllumination { get; set; }
Property Value
GlobalIlluminationSettings

IsBounded

Gets or sets the value indicating whether the bounds of the volume are taken into account. If false, the volume affects the entire world, regardless of its bounds. If true, the volume only has an effect within its bounds.

Declaration
[EditorDisplay("PostFx Volume", null)]
[EditorOrder(90)]
[Unmanaged]
public bool IsBounded { get; set; }
Property Value
System.Boolean

LensFlares

The lens flares effect settings.

Declaration
[EditorDisplay("Lens Flares", null)]
[EditorOrder(700)]
[Unmanaged]
public LensFlaresSettings LensFlares { get; set; }
Property Value
LensFlaresSettings

MotionBlur

The motion blur effect settings.

Declaration
[EditorDisplay("Motion Blur", null)]
[EditorOrder(900)]
[Unmanaged]
public MotionBlurSettings MotionBlur { get; set; }
Property Value
MotionBlurSettings

PostFxMaterials

The PostFx materials rendering settings.

Declaration
[EditorDisplay("PostFx Materials", null)]
[NoAnimate]
[EditorOrder(1200)]
[Unmanaged]
public PostFxMaterialsSettings PostFxMaterials { get; set; }
Property Value
PostFxMaterialsSettings

Priority

Gets or sets the order in which multiple volumes are blended together. The volume with the highest priority takes precedence over all other overlapping volumes.

Declaration
[EditorDisplay("PostFx Volume", null)]
[EditorOrder(60)]
[Unmanaged]
public int Priority { get; set; }
Property Value
System.Int32

ScreenSpaceReflections

The screen space reflections effect settings.

Declaration
[EditorDisplay("Screen Space Reflections", null)]
[EditorOrder(1000)]
[Unmanaged]
public ScreenSpaceReflectionsSettings ScreenSpaceReflections { get; set; }
Property Value
ScreenSpaceReflectionsSettings

ToneMapping

The tone mapping effect settings.

Declaration
[EditorDisplay("Tone Mapping", null)]
[EditorOrder(300)]
[Unmanaged]
public ToneMappingSettings ToneMapping { get; set; }
Property Value
ToneMappingSettings

Methods

AddPostFxMaterial(MaterialBase)

Adds the post fx material to the settings.

Declaration
[Unmanaged]
public void AddPostFxMaterial(MaterialBase material)
Parameters
MaterialBase material

The material.

RemovePostFxMaterial(MaterialBase)

Removes the post fx material from the settings.

Declaration
[Unmanaged]
public void RemovePostFxMaterial(MaterialBase material)
Parameters
MaterialBase material

The material.

Extension Methods