Navigation
API > API/Runtime > API/Runtime/Engine
PostProcessComponent. Enables Post process controls for blueprints. Will use a parent UShapeComponent to provide volume data if available.
| Name | UPostProcessComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/PostProcessComponent.h |
| Include Path | #include "Components/PostProcessComponent.h" |
Syntax
UCLASS (ClassGroup=Rendering, CollapseCategories, HideCategories=(Object), EditInlineNew,
Meta=(BlueprintSpawnableComponent), MinimalAPI)
class UPostProcessComponent :
public USceneComponent ,
public IInterface_PostProcessVolume
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPostProcessComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPostProcessComponent
(
const FObjectInitializer& ObjectInitializer |
Components/PostProcessComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEnabled | uint32 | Whether this volume is enabled or not. | Components/PostProcessComponent.h |
|
| BlendRadius | float | World space radius around the volume that is used for blending (only if not unbound). | Components/PostProcessComponent.h |
|
| BlendWeight | float | 0:no effect, 1:full effect | Components/PostProcessComponent.h |
|
| bUnbound | uint32 | Set this to false to use the parent shape component as volume bounds. | Components/PostProcessComponent.h |
|
| Priority | float | Priority of this volume. | Components/PostProcessComponent.h |
|
| Settings | FPostProcessSettings | Post process settings to use for this volume. | Components/PostProcessComponent.h |
|
| VolumeGuid | FGuid | Automatically generated GUID for this post process volume, used for deterministic sorting of equal priority volumes. | Components/PostProcessComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddOrUpdateBlendable
(
TScriptInterface< IBlendableInterface > InBlendableObject, |
Adds an Blendable (implements IBlendableInterface) to the array of Blendables (if it doesn't exist) and update the weight | Components/PostProcessComponent.h |
|
Overridden from IInterface_PostProcessVolume
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool EncompassesPoint
(
FVector Point, |
Components/PostProcessComponent.h | ||
virtual FPostProcessVolumeProperties GetProperties() |
Components/PostProcessComponent.h |
Protected
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnRegister() |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. | Components/PostProcessComponent.h | |
virtual void OnUnregister () |
Called when a component is unregistered. | Components/PostProcessComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostInitProperties() |
Components/PostProcessComponent.h | ||
virtual void Serialize
(
FArchive& Ar |
Components/PostProcessComponent.h |