UE3:PostProcessVolume (UT3)

Object >> Actor >> Brush >> Volume >> PostProcessVolume

Package: 

Engine

This class in other games:

UDK

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Used to affect post process settings in the game and editor.

Properties

Property group 'PostProcessVolume'

bEnabled

Type: bool

Whether this volume is enabled or not.

Default value: True

Priority

Type: float

Priority of this volume. In the case of overlapping volumes the one with the highest priority is chosen. The order is undefined if two or more overlapping volumes have the same priority.

Settings

Type: PostProcessSettings

Post process settings to use for this volume.

Default value:

Member	Value
bEnableBloom	True
bEnableSceneEffect	True
Bloom_InterpolationDuration	1.0
Bloom_Scale	1.0
DOF_BlurKernelSize	16.0
DOF_FalloffExponent	4.0
DOF_FocusInnerRadius	2000.0
DOF_InterpolationDuration	1.0
DOF_MaxFarBlurAmount	1.0
DOF_MaxNearBlurAmount	1.0
DOF_ModulateBlurColor	Member Value A 255 B 255 G 255 R 255
MotionBlur_Amount	0.5
MotionBlur_CameraRotationThreshold	45.0
MotionBlur_CameraTranslationThreshold	10000.0
MotionBlur_FullMotionBlur	True
MotionBlur_InterpolationDuration	1.0
MotionBlur_MaxVelocity	1.0
Scene_HighLights	Member Value X 1.0 Y 1.0 Z 1.0
Scene_InterpolationDuration	1.0
Scene_MidTones	Member Value X 1.0 Y 1.0 Z 1.0

Internal variables

NextLowerPriorityVolume

Type: PostProcessVolume

Modifiers: const, noimport, transient

Next volume in linked listed, sorted by priority in descending order.

Default values

Property	Value
bCollideActors	False
bStasis	True
bStatic	False
CollisionType	COLLIDE_NoCollision

Subobjects

BrushComponent0

Class: Engine.BrushComponent

Inherits from: Volume.BrushComponent0

Property	Value
BlockNonZeroExtent	False
CollideActors	False

Structs

PostProcessSettings

Modifiers: native

bool bEnableBloom 

Whether to use bloom effect.

bool bEnableDOF 

Whether to use depth of field effect.

bool bEnableMotionBlur 

Whether to use motion blur effect.

bool bEnableSceneEffect 

Whether to use the material/ scene effect.

float Bloom_Scale 

Scale for the blooming.

float Bloom_InterpolationDuration 

Duration over which to interpolate values to.

float DOF_FalloffExponent 

Exponent to apply to blur amount after it has been normalized to [0,1].

float DOF_BlurKernelSize 

Affects the size of the Poisson disc kernel.

float DOF_MaxNearBlurAmount 

[0,1] value for clamping how much blur to apply to items in front of the focus plane.

float DOF_MaxFarBlurAmount 

[0,1] value for clamping how much blur to apply to items behind the focus plane.

Object.Color DOF_ModulateBlurColor 

Blur color for debugging etc.

DOFEffect.EFocusType DOF_FocusType 

Controls how the focus point is determined.

float DOF_FocusInnerRadius 

Inner focus radius.

float DOF_FocusDistance 

Used when FOCUS_Distance is enabled.

Object.Vector DOF_FocusPosition 

Used when FOCUS_Position is enabled.

float DOF_InterpolationDuration 

Duration over which to interpolate values to.

float MotionBlur_MaxVelocity 

Maximum blur velocity amount. This is a clamp on the amount of blur.

float MotionBlur_Amount 

This is a scalar on the blur

bool MotionBlur_FullMotionBlur 

Whether everything (static/dynamic objects) should motion blur or not. If disabled, only moving objects may blur.

float MotionBlur_CameraRotationThreshold 

Threshhold for when to turn off motion blur when the camera rotates swiftly during a single frame (in degrees).

float MotionBlur_CameraTranslationThreshold 

Threshhold for when to turn off motion blur when the camera translates swiftly during a single frame (in world units).

float MotionBlur_InterpolationDuration 

Duration over which to interpolate values to.

float Scene_Desaturation 

Desaturation amount.

Object.Vector Scene_HighLights 

Controlling white point.

Object.Vector Scene_MidTones 

Controlling gamma curve.

Object.Vector Scene_Shadows 

Controlling black point.

float Scene_InterpolationDuration 

Duration over which to interpolate values to.

Default values:

Property	Value
bEnableBloom	True
bEnableDOF	False
bEnableMotionBlur	False
bEnableSceneEffect	True
Bloom_InterpolationDuration	1.0
Bloom_Scale	1.0
DOF_BlurKernelSize	16.0
DOF_FalloffExponent	4.0
DOF_FocusDistance	0.0
DOF_FocusInnerRadius	2000.0
DOF_FocusType	FOCUS_Distance
DOF_InterpolationDuration	1.0
DOF_MaxFarBlurAmount	1.0
DOF_MaxNearBlurAmount	1.0
DOF_ModulateBlurColor	Member Value A 255 B 255 G 255 R 255
MotionBlur_Amount	0.5
MotionBlur_CameraRotationThreshold	45.0
MotionBlur_CameraTranslationThreshold	10000.0
MotionBlur_FullMotionBlur	True
MotionBlur_InterpolationDuration	1.0
MotionBlur_MaxVelocity	1.0
Scene_Desaturation	0.0
Scene_HighLights	Member Value X 1.0 Y 1.0 Z 1.0
Scene_InterpolationDuration	1.0
Scene_MidTones	Member Value X 1.0 Y 1.0 Z 1.0
Scene_Shadows	Member Value X 0.0 Y 0.0 Z 0.0

Instance functions

OnToggle

simulated function OnToggle (SeqAct_Toggle action)

Overrides: Volume.OnToggle