AColorCorrectRegion

An instance of Color Correction Region.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ColorCorrectRegions

Header

/Engine/Plugins/Experimental/ColorCorrectRegions/Source/ColorCorrectRegions/Public/ColorCorrectRegion.h

Include

#include "ColorCorrectRegion.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable)
class AColorCorrectRegion : public AActor

Remarks

An instance of Color Correction Region. Used to aggregate all active regions. This actor is aggregated by ColorCorrectRegionsSubsystem which handles:

  • Level Loaded, Undo/Redo, Added to level, Removed from level events. AActor class itself is not aware of when it is added/removed, Undo/Redo etc in the Editor. AColorCorrectRegion reaches out to UColorCorrectRegionsSubsystem when its priority is changed, requesting regions to be sorted or during BeginPlay/EndPlay to register itself. More information in ColorCorrectRegionsSubsytem.h

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FColorGradingSe ...

 

ColorGradingSettings

Color correction settings.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

Enabled

Enable/Disable color correction provided by this region.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

ExcludeStencil

Enable stenciling.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

float

 

Falloff

  1. Softening the region.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

float

 

Inner

Inner of the region. Swapped with Outer in case it is higher than Outer.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

float

 

Intensity

Color correction intensity. Clamped to 0-1 range.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

Invert

Invert region.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

float

 

Outer

Outer of the region.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

int32

 

Priority

Render priority/order.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

Temperature

Color correction temperature.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

EColorCorrectRe ...

 

Type

Region type.

Constructors

Name Description

Public function

AColorCorrectRegion

(
    const FObjectInitializer & ObjectIn...
)

Overridden from AActor

Name Description

Public function Virtual

void

 

BeginPlay()

To handle play in Editor, PIE and Standalone.

Public function Virtual

void

 

EndPlay

(
    const EEndPlayReason::Type EndPlayR...
)

Overridable function called whenever this actor is being removed from a level

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when any of the properties are changed.

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