Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

AColorCorrectRegion

An instance of Color Correction Region.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AColorCorrectRegion

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
FColorGradingSe...	ColorGradingSettings	Color correction settings.
bool	Enabled	Enable/Disable color correction provided by this region.
bool	ExcludeStencil	Enable stenciling.
float	Falloff	Softening the region.
float	Inner	Inner of the region. Swapped with Outer in case it is higher than Outer.
float	Intensity	Color correction intensity. Clamped to 0-1 range.
bool	Invert	Invert region.
float	Outer	Outer of the region.
int32	Priority	Render priority/order.
float	Temperature	Color correction temperature.
EColorCorrectRe...	Type	Region type.

Constructors

	Name	Description
	AColorCorrectRegion ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	void	Cleanup()	We have to manage the lifetime of the region ourselves, because EndPlay is not guaranteed to be called and BeginDestroy could be called from GC when it is too late.

Overridden from AActor

		Name	Description
	void	BeginPlay()	To handle play in Editor, PIE and Standalone.
	void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when any of the properties are changed.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss