UAccumulationDOFComponent

API > API/Plugins > API/Plugins/AccumulationDOF

Settings component for cinematic aperture-sampled depth of field.

Attach to a CineCameraActor to configure DOF rendering settings for:

Movie Render Queue (via AccumulationDOF pass)
Editor viewport preview (Level Viewport >> Scalability & Performance >> Accumulation DOF)


Name	UAccumulationDOFComponent
Type	class
Header File	/Engine/Plugins/VirtualProduction/AccumulationDOF/Source/AccumulationDOF/Public/AccumulationDOFComponent.h
Include Path	#include "AccumulationDOFComponent.h"

Syntax

UCLASS (Blueprintable, ClassGroup=(Rendering),  
       Meta=(BlueprintSpawnableComponent, DisplayName="Accumulation DOF"))  
class UAccumulationDOFComponent : public UActorComponent

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UAccumulationDOFComponent

Implements Interfaces

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UAccumulationDOFComponent()		AccumulationDOFComponent.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AxialChromaticAberrationIntensity	float	Aberrations Axial chromatic aberration intensity as percentage of focus distance in %.	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Chromatic Aberration" Meta=(ClampMin="0.0", UIMin="0.0", UIMax="100.0")
bEnableBokehTexture	bool	Enable bokeh texture	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field\|Bokeh"
bEnableMotionBlur	bool	Enable motion blur on the accumulated DOF result.	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field"
BokehEdgeSoftness	float	Softness of bokeh edges 0.0 - 1.0.	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field\|Bokeh" Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
BokehTexture	TObjectPtr< UTexture2D >	Bokeh Settings Bokeh texture to weight aperture samples.	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field\|Bokeh"
bSpectralLateralChromaticAberration	bool	Spectral (actually multi-band) lateral chromatic aberration	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Chromatic Aberration"
bUseJitterAA	bool	Use Halton jitter AA instead of per-sample TAA. When disabled, TAA runs on each sample.	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field" AdvancedDisplay
ComaAberration	float	Coma aberration strength (Seidel W131).	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Monochromatic Aberrations" Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0")
meta		Fraction of main aperture diameter for DOF splat size (0.125 = 1/8th, 1.0 = full aperture, 0 = disabled).	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field" Meta=(DisplayName="DOF Splat Size", ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
NumSamples	int32	Specifies the number of aperture samples to render (use more for better quality, but will take more time).	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field" Meta=(ClampMin="1", UIMin="1", UIMax="32768")
SamplingPattern	EApertureSamplingPattern	Aperture sampling pattern. Hexaweb is generally preferred but Vogel Spirals are pretty good too.	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field" AdvancedDisplay
SphericalAberration	float	Primary spherical aberration coefficient (Seidel W040) in cm.	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Monochromatic Aberrations" Meta=(ClampMin="0.0", UIMin="0.0", UIMax="100.0")
TemporalHistoryMode	ETemporalHistoryMode	Controls how temporal history is updated during aperture sampling. Prefer Last for now	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field" AdvancedDisplay
TintStrength	float	Strength of bokeh tint application 0.0 - 1.0	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field\|Bokeh" Meta=(EditCondition="BokehTexture != nullptr", ClampMin="0.0", ClampMax="1.0")
WeightChannel	EBokehWeightChannel	Which channel to extract weight from bokeh texture	AccumulationDOFComponent.h	EditAnywhere BlueprintReadWrite Category="Accumulation Depth of Field\|Bokeh" Meta=(EditCondition="BokehTexture != nullptr")

Navigation

Syntax

Inheritance Hierarchy

Implements Interfaces

Constructors

Variables

Public

Functions

Public