Cogito, ergo sum

Difference between revisions of "UE3:PostProcessVolume (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
(Talk)
Line 25: Line 25:
  
 
====Settings====
 
====Settings====
−
'''Type:''' {{tl|PostProcessSettings}}
+
'''Type:''' {{tl|PostProcessSettings||PostProcessVolume structs}}
  
 
Post process settings to use for this volume.
 
Post process settings to use for this volume.
Line 31: Line 31:
 
'''Default value:'''  
 
'''Default value:'''  
 
{| class="list defaults"
 
{| class="list defaults"
−
! {{tl|PostProcessSettings|||Member}}
+
! {{tl|PostProcessSettings||PostProcessVolume structs|Member}}
 
! Value
 
! Value
 
|-
 
|-
Line 51: Line 51:
 
| Bloom_Scale
 
| Bloom_Scale
 
| 1.0
 
| 1.0
 +
|-
 +
| bOverride_AllowAmbientOcclusion
 +
| True
 +
|-
 +
| bOverride_Bloom_InterpolationDuration
 +
| True
 +
|-
 +
| bOverride_Bloom_Scale
 +
| True
 +
|-
 +
| bOverride_DOF_BlurBloomKernelSize
 +
| True
 +
|-
 +
| bOverride_DOF_BlurKernelSize
 +
| True
 +
|-
 +
| bOverride_DOF_FalloffExponent
 +
| True
 +
|-
 +
| bOverride_DOF_FocusDistance
 +
| True
 +
|-
 +
| bOverride_DOF_FocusInnerRadius
 +
| True
 +
|-
 +
| bOverride_DOF_FocusPosition
 +
| True
 +
|-
 +
| bOverride_DOF_FocusType
 +
| True
 +
|-
 +
| bOverride_DOF_InterpolationDuration
 +
| True
 +
|-
 +
| bOverride_DOF_MaxFarBlurAmount
 +
| True
 +
|-
 +
| bOverride_DOF_MaxNearBlurAmount
 +
| True
 +
|-
 +
| bOverride_DOF_ModulateBlurColor
 +
| True
 +
|-
 +
| bOverride_EnableBloom
 +
| True
 +
|-
 +
| bOverride_EnableDOF
 +
| True
 +
|-
 +
| bOverride_EnableMotionBlur
 +
| True
 +
|-
 +
| bOverride_EnableSceneEffect
 +
| True
 +
|-
 +
| bOverride_MotionBlur_Amount
 +
| True
 +
|-
 +
| bOverride_MotionBlur_CameraRotationThreshold
 +
| True
 +
|-
 +
| bOverride_MotionBlur_CameraTranslationThreshold
 +
| True
 +
|-
 +
| bOverride_MotionBlur_FullMotionBlur
 +
| True
 +
|-
 +
| bOverride_MotionBlur_InterpolationDuration
 +
| True
 +
|-
 +
| bOverride_MotionBlur_MaxVelocity
 +
| True
 +
|-
 +
| bOverride_OverrideRimShaderColor
 +
| True
 +
|-
 +
| bOverride_RimShader_Color
 +
| True
 +
|-
 +
| bOverride_RimShader_InterpolationDuration
 +
| True
 +
|-
 +
| bOverride_Scene_Desaturation
 +
| True
 +
|-
 +
| bOverride_Scene_HighLights
 +
| True
 +
|-
 +
| bOverride_Scene_InterpolationDuration
 +
| True
 +
|-
 +
| bOverride_Scene_MidTones
 +
| True
 +
|-
 +
| bOverride_Scene_Shadows
 +
| True
 +
|-
 +
| DOF_BlurBloomKernelSize
 +
| 16.0
 
|-
 
|-
 
| DOF_BlurKernelSize
 
| DOF_BlurKernelSize
Line 180: Line 279:
 
| {{tl|bCollideActors||Actor internal variables}}
 
| {{tl|bCollideActors||Actor internal variables}}
 
| False
 
| False
−
|-
 
−
| {{tl|bStasis||Actor internal variables}}
 
−
| True
 
 
|-
 
|-
 
| {{tl|bStatic||Actor internal variables}}
 
| {{tl|bStatic||Actor internal variables}}
 
| False
 
| False
 +
|-
 +
| {{tl|bTickIsDisabled||Actor internal variables}}
 +
| True
 
|-
 
|-
 
| {{tl|CollisionType||Actor}}
 
| {{tl|CollisionType||Actor}}
Line 212: Line 311:
  
 
==Structs==
 
==Structs==
−
===PostProcessSettings===
+
See {{cl|PostProcessVolume structs}}.
−
'''[[Structs#Modifiers|Modifiers]]:''' native
+
−
 
+
−
<!-- enter struct description -->
+
−
; [[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.
+
−
; [[bool]] bAllowAmbientOcclusion : Whether to allow ambient occlusion.
+
−
; [[bool]] bOverrideRimShaderColor : Whether to override the rim shader color.
+
−
; [[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.
+
−
; {{tl|Color|Object|structs}} DOF_ModulateBlurColor : Blur color for debugging etc.
+
−
; {{tl|EFocusType|DOFEffect}} DOF_FocusType : Controls how the focus point is determined.
+
−
; [[float]] DOF_FocusInnerRadius : Inner focus radius.
+
−
; [[float]] DOF_FocusDistance : Used when FOCUS_Distance is enabled.
+
−
; {{tl|Vector|Object|structs}} 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.
+
−
; {{tl|Vector|Object|structs}} Scene_HighLights : Controlling white point.
+
−
; {{tl|Vector|Object|structs}} Scene_MidTones : Controlling gamma curve.
+
−
; {{tl|Vector|Object|structs}} Scene_Shadows : Controlling black point.
+
−
; [[float]] Scene_InterpolationDuration : Duration over which to interpolate values to.
+
−
; {{tl|LinearColor|Object|structs}} RimShader_Color : Controlling rim shader color.
+
−
; [[float]] RimShader_InterpolationDuration : Duration over which to interpolate values to.
+
−
 
+
−
'''Default values:'''
+
−
{| class="list defaults"
+
−
! Property
+
−
! Value
+
−
|-
+
−
| bAllowAmbientOcclusion
+
−
| True
+
−
|-
+
−
| bEnableBloom
+
−
| True
+
−
|-
+
−
| bEnableDOF
+
−
| False
+
−
|-
+
−
| bEnableMotionBlur
+
−
| True
+
−
|-
+
−
| bEnableSceneEffect
+
−
| True
+
−
|-
+
−
| Bloom_InterpolationDuration
+
−
| 1.0
+
−
|-
+
−
| Bloom_Scale
+
−
| 1.0
+
−
|-
+
−
| bOverrideRimShaderColor
+
−
| False
+
−
|-
+
−
| DOF_BlurKernelSize
+
−
| 16.0
+
−
|-
+
−
| DOF_FalloffExponent
+
−
| 4.0
+
−
|-
+
−
| DOF_FocusDistance
+
−
| 0.0
+
−
|-
+
−
| DOF_FocusInnerRadius
+
−
| 2000.0
+
−
|-
+
−
| DOF_FocusType
+
−
| {{tl|EFocusType||DOFEffect|FOCUS_Distance}}
+
−
|-
+
−
| DOF_InterpolationDuration
+
−
| 1.0
+
−
|-
+
−
| DOF_MaxFarBlurAmount
+
−
| 1.0
+
−
|-
+
−
| DOF_MaxNearBlurAmount
+
−
| 1.0
+
−
|-
+
−
| DOF_ModulateBlurColor
+
−
|
+
−
{| class="list defaults"
+
−
! {{tl|Color||Object structs|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
+
−
|-
+
−
| RimShader_Color
+
−
|
+
−
{| class="list defaults"
+
−
! {{tl|LinearColor||Object structs|Member}}
+
−
! Value
+
−
|-
+
−
| A
+
−
| 1.0
+
−
|-
+
−
| B
+
−
| 0.827726
+
−
|-
+
−
| G
+
−
| 0.585973
+
−
|-
+
−
| R
+
−
| 0.47044
+
−
|}
+
−
|-
+
−
| RimShader_InterpolationDuration
+
−
| 1.0
+
−
|-
+
−
| Scene_Desaturation
+
−
| 0.0
+
−
|-
+
−
| Scene_HighLights
+
−
|
+
−
{| class="list defaults"
+
−
! {{tl|Vector||Object structs|Member}}
+
−
! Value
+
−
|-
+
−
| X
+
−
| 1.0
+
−
|-
+
−
| Y
+
−
| 1.0
+
−
|-
+
−
| Z
+
−
| 1.0
+
−
|}
+
−
|-
+
−
| Scene_InterpolationDuration
+
−
| 1.0
+
−
|-
+
−
| Scene_MidTones
+
−
|
+
−
{| class="list defaults"
+
−
! {{tl|Vector||Object structs|Member}}
+
−
! Value
+
−
|-
+
−
| X
+
−
| 1.0
+
−
|-
+
−
| Y
+
−
| 1.0
+
−
|-
+
−
| Z
+
−
| 1.0
+
−
|}
+
−
|-
+
−
| Scene_Shadows
+
−
|
+
−
{| class="list defaults"
+
−
! {{tl|Vector||Object structs|Member}}
+
−
! Value
+
−
|-
+
−
| X
+
−
| 0.0
+
−
|-
+
−
| Y
+
−
| 0.0
+
−
|-
+
−
| Z
+
−
| 0.0
+
−
|}
+
−
|}
+
  
 
==Instance functions==
 
==Instance functions==

Revision as of 06:24, 17 January 2010

UDK Object >> Actor >> Brush >> Volume >> PostProcessVolume
Package: 
Engine
This class in other games:
UT3
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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
bAllowAmbientOcclusion True
bEnableBloom True
bEnableMotionBlur True
bEnableSceneEffect True
Bloom_InterpolationDuration 1.0
Bloom_Scale 1.0
bOverride_AllowAmbientOcclusion True
bOverride_Bloom_InterpolationDuration True
bOverride_Bloom_Scale True
bOverride_DOF_BlurBloomKernelSize True
bOverride_DOF_BlurKernelSize True
bOverride_DOF_FalloffExponent True
bOverride_DOF_FocusDistance True
bOverride_DOF_FocusInnerRadius True
bOverride_DOF_FocusPosition True
bOverride_DOF_FocusType True
bOverride_DOF_InterpolationDuration True
bOverride_DOF_MaxFarBlurAmount True
bOverride_DOF_MaxNearBlurAmount True
bOverride_DOF_ModulateBlurColor True
bOverride_EnableBloom True
bOverride_EnableDOF True
bOverride_EnableMotionBlur True
bOverride_EnableSceneEffect True
bOverride_MotionBlur_Amount True
bOverride_MotionBlur_CameraRotationThreshold True
bOverride_MotionBlur_CameraTranslationThreshold True
bOverride_MotionBlur_FullMotionBlur True
bOverride_MotionBlur_InterpolationDuration True
bOverride_MotionBlur_MaxVelocity True
bOverride_OverrideRimShaderColor True
bOverride_RimShader_Color True
bOverride_RimShader_InterpolationDuration True
bOverride_Scene_Desaturation True
bOverride_Scene_HighLights True
bOverride_Scene_InterpolationDuration True
bOverride_Scene_MidTones True
bOverride_Scene_Shadows True
DOF_BlurBloomKernelSize 16.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
RimShader_Color
Member Value
A 1.0
B 0.827726
G 0.585973
R 0.47044
RimShader_InterpolationDuration 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
bStatic False
bTickIsDisabled True
CollisionType COLLIDE_CustomDefault

Subobjects

BrushComponent0

Class: Engine.BrushComponent

Inherits from: Volume.BrushComponent0

Property Value
BlockNonZeroExtent False
CollideActors False
ReplacementPrimitive None

Structs

See PostProcessVolume structs.

Instance functions

OnToggle

simulated function OnToggle (SeqAct_Toggle action)

Overrides: Volume.OnToggle


Retrieved from "https://wiki.beyondunreal.com/UE3:PostProcessVolume_(UDK)?oldid=41360"