UPostProcessComponent

PostProcessComponent.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Components/PostProcessComponent.h

Include

#include "Components/PostProcessComponent.h"

Syntax

class UPostProcessComponent :
    public USceneComponent,
    public IInterface_PostProcessVolume

Remarks

  1. Enables Post process controls for blueprints. Will use a parent UShapeComponent to provide volume data if available.

Variables

Name Description

Public variable

uint32: 1

 

bEnabled

Whether this volume is enabled or not.

Public variable

float

 

BlendRadius

World space radius around the volume that is used for blending (only if not unbound).

Public variable

float

 

BlendWeight

0:no effect, 1:full effect

Public variable

uint32: 1

 

bUnbound

Set this to false to use the parent shape component as volume bounds.

Public variable

float

 

Priority

Priority of this volume.

Public variable

FPostProcessSet...

 

Settings

Post process settings to use for this volume.

Constructors

Name Description

Public function

UPostProcessComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

AddOrUpdateBlendable

(
    TScriptInterface< IBlendableInterfa...,
    float InWeight
)

Adds an Blendable (implements IBlendableInterface) to the array of Blendables (if it doesn't exist) and update the weight

Overridden from UActorComponent

Name Description

Protected function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Protected function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Overridden from UObject

Name Description

Protected function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_PostProcessVolume

Name Description

Public function Virtual

bool

 

EncompassesPoint

(
    FVector Point,
    float SphereRadius,
    float* OutDistanceToPoint
)

Public function Virtual Const

FPostProcess...

 

GetProperties()
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss