APostProcessVolume

For FPostprocessSettings

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/PostProcessVolume.h

Include

#include "Engine/PostProcessVolume.h"

Syntax

class APostProcessVolume :
    public AVolume,
    public IInterface_PostProcessVolume

Remarks

PostProcessVolume: a post process settings volume Used to affect post process settings in the game and editor.

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

Whether this volume covers the whole world, or just the area inside its bounds.

Public variable

float

 

Priority

Priority of this volume.

Public variable

FPostProcessSettings

 

Settings

Post process settings to use for this volume.

Constructors

Name Description

Public function

APostProcessVolume

(
    const FObjectInitializer& ObjectInitializer
)

Functions

Name Description

Public function

void

 

AddOrUpdateBlendable

(
    TScriptInterface< IBlendableInterface > InBlendableObject,
    float InWeight
)

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

Overridden from AActor

Name Description

Protected function Virtual

void

 

PostRegisterAllComponents()

Called after all the components in the Components array are registered, called both in editor and during gameplay

Public function Virtual

void

 

PostUnregisterAllComponents()

Called after all currently registered components are cleared

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

CanEditChange

(
    const UProperty* InProperty
)

Called by the editor to query whether a property of this object is allowed to be modified.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyChangedEvent
)

Called when a property on this object has been modified externally

Public 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

FPostProcessVolumeProperties

 

GetProperties()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback